1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
Generating Output
=================
A standard ``cmd`` application can produce output by using either of these
methods::
print("Greetings, Professor Falken.", file=self.stdout)
self.stdout.write("Shall we play a game?\n")
While you could send output directly to ``sys.stdout``, ``cmd`` can be
initialized with a ``stdin`` and ``stdout`` variables, which it stores
as ``self.stdin`` and ``self.stdout``. By using these variables every
time you produce output, you can trivially change where all the output
goes by changing how you initialize your class.
``cmd2`` extends this approach in a number of convenient ways. See
:ref:`features/redirection:Output Redirection And Pipes` for information on how
users can change where the output of a command is sent. In order for those
features to work, the output you generate must be sent to ``self.stdout``. You
can use the methods described above, and everything will work fine. ``cmd2``
also adds a number of output related methods to ``Cmd2.Cmd`` which you may use
to enhance the output your application produces.
TODO:
- perror
- pwarning
- pexcept
- ppaging
- column formatting?
- wcswidth?
- exceptions
Ordinary Output
---------------
The :meth:`.cmd2.Cmd.poutput` method is similar to the Python
`built-in print function <https://docs.python.org/3/library/functions.html#print>`_. :meth:`~cmd2.cmd2.Cmd.poutput` adds two
conveniences.
1. Since users can pipe output to a shell command, it catches
``BrokenPipeError`` and outputs the contents of
``self.broken_pipe_warning`` to ``stderr``. ``self.broken_pipe_warning``
defaults to an empty string so this method will just swallow the exception.
If you want to show an error message, put it in
``self.broken_pipe_warning`` when you initialize ``Cmd2.cmd``.
2. It examines and honors the :ref:`features/settings:allow_ansi` setting.
See :ref:`features/generating_output:Colored Output` below for more details.
Here's a simple command that shows this method in action::
def do_echo(self, args):
"""A simple command showing how poutput() works"""
self.poutput(args)
Colored Output
--------------
You may want to generate output in different colors, which is typically done by
adding `ANSI escape sequences
<https://en.wikipedia.org/wiki/ANSI_escape_code#Colors>`_ which tell the
terminal to change the foreground and background colors. If you want to give
yourself a headache, you can generate these by hand. You could also use another
Python color library like `plumbum.colors
<https://plumbum.readthedocs.io/en/latest/colors.html>`_, `colored
<https://gitlab.com/dslackw/colored>`_, or `colorama
<https://github.com/tartley/colorama>`_. Colorama is unique because when it's
running on Windows, it wraps ``stdout``, looks for ANSI escape sequences, and
converts them into the appropriate ``win32`` calls to modify the state of the
terminal.
``cmd2`` imports and uses Colorama and provides a number of convenience methods
for generating colorized output, measuring the screen width of colorized
output, setting the window title in the terminal, and removing ANSI escape
codes from a string. These functions are all documentated in
:mod:`cmd2.ansi`.
:mod:`cmd2.cmd2.Cmd` includes an :ref:`features/settings:allow_ansi` setting,
which controls whether ANSI escape sequences that instruct the terminal to
colorize output are stripped from the output. The recommended approach is to
construct your application so that it generates colorized output, and then
allow your users to use this setting to remove the colorization if they do not
want it.
Output generated by any of these
methods will honor the :ref:`features/settings:allow_ansi` setting:
- :meth:`cmd2.cmd2.Cmd.poutput`
- :meth:`cmd2.cmd2.Cmd.perror`
- :meth:`cmd2.cmd2.Cmd.pwarning`
- :meth:`cmd2.cmd2.Cmd.pexcept`
- :meth:`cmd2.cmd2.Cmd.pfeedback`
- :meth:`cmd2.cmd2.Cmd.ppaged`
Error Messages
--------------
Warning Messages
----------------
Feedback
--------
You may have the need to display information to the user which is not intended
to be part of the generated output. This could be debugging information or
status information about the progress of long running commands. It's not
output, it's not error messages, it's feedback. If you use the
:ref:`features/settings:Timing` setting, the output of how long it took the
command to run will be output as feedback. ``cmd2`` has a ``self.pfeedback()``
method to produce this type of output, and several
:ref:`features/settings:Settings` to control how this output is handled.
If the ``quiet`` setting is ``True``, then calling ``self.pfeedback()``
produces no output. If ``quiet`` is ``False``, then the ``feedback_to_output``
setting is consulted to determine which file descriptor the feedback will be
sent to. The default value of ``False`` means all feedback is sent to
``sys.stderr``. If set to ``True``, then the feedback output will be sent to
``self.stdout`` along with the rest of the generated output.
Exceptions
----------
Paging Output
-------------
Centering Text
--------------
utils.center_text()
Columnar Output
---------------
Using wcswidth() and ansi.ansi_safe_wcswidth()
|
