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
|
# Copyright 2010, 2011 Lars Wirzenius
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import sys
import ttystatus
class TerminalStatus(object):
'''Show status and progress information on a terminal.
All output is provided via widgets of various kinds. Many widgets
format data that TerminalStatus stores. TerminalStatus provides a
dict interface for setting and retrieving data items. Unlike a real
dict, getting a value for a key that has not been set does not
result in a KeyError exception, but in the empty string being
returned.
'''
def __init__(self, output=None, period=None, messager=None):
self._m = messager or ttystatus.Messager(output=output, period=period)
self.clear()
def add(self, widget):
'''Add a new widget to the status display.'''
self._widgets.append(widget)
def format(self, format_string):
'''Add new widgets based on format string.
The format string is taken literally, except that ``%%`` is a
literal percent character, and ``%Foo(a,b,c)`` is a widget
of type ``Foo`` with parameters a, b, and c. For example:
``format("hello, %String(name)")``.
'''
for widget in ttystatus.fmt.parse(format_string):
self.add(widget)
def clear(self):
'''Remove all widgets.'''
self._widgets = []
self._values = dict()
self._m.clear()
def __getitem__(self, key):
'''Return value for key, or the empty string.'''
return self._values.get(key, '')
def get(self, key, default=None):
'''Like dict.get.'''
return self._values.get(key, default)
def __setitem__(self, key, value):
'''Set value for key.'''
self._values[key] = value
for w in self._widgets:
w.update(self)
if self._m.time_to_write():
self._write()
def _render(self):
'''Render current state of all widgets.'''
remaining = self._m.width
texts = [None] * len(self._widgets)
for i, w in enumerate(self._widgets):
if w.static_width:
texts[i] = w.render(0)
remaining -= len(texts[i])
for i, w in enumerate(self._widgets):
if not w.static_width:
texts[i] = w.render(remaining)
remaining -= len(texts[i])
return ''.join(texts)
def _write(self):
'''Render and output current state of all widgets.'''
self._m.write(self._render())
def increase(self, key, delta):
'''Increase value for a key by a given amount.'''
self[key] = (self[key] or 0) + delta
def notify(self, msg):
'''Show a message.'''
self._m.notify(msg, sys.stdout)
def error(self, msg):
'''Write an error message.'''
self._m.notify(msg, sys.stderr)
def finish(self):
'''Finish status display.'''
self._write()
self._m.finish()
def disable(self):
'''Disable all output.'''
self._m.disable()
def enable(self):
'''Enable output if it has been disabled.'''
self._m.enable()
|
