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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
#!/usr/bin/python
# Copyright 2003-2023 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
import sys
from portage.output import blue, yellow, teal, green, red
from gentoolkit.pprinter import cpv, number
class OutputControl:
"""Outputs data according to predetermined options and handles any user
interaction.
@param options: dictionary of boolean options as determined in cli.py
used here: interactive, pretend, quiet, accept_all, nocolor.
"""
def __init__(self, options):
if not options:
# set some defaults
self.options["interactive"] = False
self.options["pretend"] = True
self.options["quiet"] = False
self.options["accept_all"] = False
self.options["nocolor"] = False
else:
self.options = options
self.set_colors("normal")
def set_colors(self, mode):
"""Sets the colors for the progress_controller
and prettysize output
@param mode: string, 1 of ["normal", "deprecated"]
"""
if mode == "normal":
self.pkg_color = cpv # green
self.numbers = number # turquoise
self.brace = blue
if mode == "invalid":
self.pkg_color = red
self.numbers = teal
elif mode == "deprecated":
self.pkg_color = yellow
self.numbers = teal # darkgreen
self.brace = blue
def einfo(self, message=""):
"""Display an info message depending on a color mode.
@param message: text string to display
@outputs to stdout.
"""
if not self.options["nocolor"]:
prefix = " " + green("*")
else:
prefix = ">>>"
print(prefix, message)
def eprompt(self, message):
"""Display a user question depending on a color mode.
@param message: text string to display
@output to stdout
"""
if not self.options["nocolor"]:
prefix = " " + red(">") + " "
else:
prefix = "??? "
sys.stdout.write(prefix + message)
sys.stdout.flush()
def prettySize(self, size, justify=False, color=None):
"""int -> byte/kilo/mega/giga converter. Optionally
justify the result. Output is a string.
@param size: integer
@param justify: optional boolean, defaults to False
@param color: optional color, defaults to green
as defined in portage.output
@returns a formatted and (escape sequenced)
colorized text string
"""
if color == None:
color = self.numbers
units = [" G", " M", " K", " B"]
# by using 1000 as the changeover, the integer portion
# of the number will never be more than 3 digits long
# but the true base 2 value of 1024 is used for the actual
# calulation to maintain better accuracy.
while len(units) and size >= 1000:
size = size / 1024.0
units.pop()
sizestr = "%.1f" % (round(size, 1)) + units[-1]
if justify:
sizestr = (
" " + self.brace("[ ") + color(sizestr.rjust(8)) + self.brace(" ]")
)
return sizestr
def yesNoAllPrompt(self, message="Do you want to proceed?"):
"""Print a prompt until user answer in yes/no/all. Return a
boolean for answer, and also may affect the 'accept_all' option.
@param message: optional different input string from the default
message of: "Do you want to proceed?"
@outputs to stdout
@modifies class var options['accept_all']
@rtype: bool
"""
user_string = "xxx"
while not user_string.lower() in ["", "y", "n", "a", "yes", "no", "all"]:
self.eprompt(message + " [Y/n/a]: ")
user_string = sys.stdin.readline().rstrip("\n")
user_string = user_string.strip()
if user_string.lower() in ["a", "all"]:
self.options["accept_all"] = True
answer = user_string.lower() in ["", "y", "a", "yes", "all"]
return answer
def progress_controller(self, size, key, clean_list, file_type):
"""Callback function for doCleanup. It outputs data according to the
options configured.
Alternatively it handles user interaction for decisions that are
required.
@param size: Integer of the file(s) size
@param key: the filename/pkgname currently being processed
@param clean_list: list of files being processed.
"""
if not self.options["quiet"]:
# pretty print mode
print(self.prettySize(size, True), self.pkg_color(key))
elif self.options["pretend"] or self.options["interactive"]:
# file list mode
if file_type == "checkout":
print(clean_list)
else:
for file_ in clean_list:
print(file_)
if self.options["pretend"]:
return False
elif (
not self.options["interactive"]
or self.options["accept_all"]
or self.yesNoAllPrompt("Do you want to delete this " + file_type + "?")
):
return True
return False
def total(self, mode, size, num_files, verb, action):
"""outputs the formatted totals to stdout
@param mode: sets color and message. 1 of ['normal', 'deprecated']
@param size: total space savings
@param num_files: total number of files
@param verb: string eg. 1 of ["would be", "has been"]
@param action: string eg 1 of ['distfiles', 'packages']
"""
self.set_colors(mode)
if mode == "normal":
message = (
"Total space from "
+ red(str(num_files))
+ " files "
+ verb
+ " freed in the "
+ action
+ " directory"
)
print(" ===========")
print(self.prettySize(size, True, red), message)
elif mode == "invalid":
message = (
red(str(num_files))
+ " invalid binpkgs "
+ verb
+ " removed from the "
+ action
+ " directory"
)
print(" ===========")
print(self.prettySize(size, True, red), message)
elif mode == "deprecated":
message = (
"Total space from "
+ red(str(num_files))
+ " package files\n"
+ " Re-run the last command with the -D "
+ "option to clean them as well"
)
print(" ===========")
print(self.prettySize(size, True, red), message)
def list_pkgs(self, pkgs):
"""outputs the packages to stdout
@param pkgs: dict. of {cat/pkg-ver: src_uri,}
"""
indent = " " * 12
keys = sorted(pkgs)
for key in keys:
if pkgs[key]:
saved = ""
else:
saved = " ...distfile name(s) not known/saved"
print(indent, self.pkg_color(key) + saved)
print()
|