/usr/lib/python3/dist-packages/diffoscope/progress.py is in diffoscope 93ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 | # -*- coding: utf-8 -*-
#
# diffoscope: in-depth comparison of files, archives, and directories
#
# Copyright © 2016 Chris Lamb <lamby@debian.org>
#
# diffoscope 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.
#
# diffoscope 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 diffoscope. If not, see <https://www.gnu.org/licenses/>.
import os
import sys
import json
import logging
logger = logging.getLogger(__name__)
class ProgressLoggingHandler(logging.StreamHandler):
def __init__(self, progressbar):
self.progressbar = progressbar
super().__init__()
def emit(self, record):
try:
# Delete the current line (i.e. the progress bar)
self.stream.write("\r\033[K")
self.flush()
super().emit(record)
if not self.progressbar.bar.finished:
self.progressbar.bar.update()
except Exception:
# Wrap otherwise tests fail due to test_progress.py call main()
# several times. This mirrors the super() implementation.
self.handleError(record)
class ProgressManager(object):
_singleton = {}
def __init__(self):
self.__dict__ = self._singleton
if not self._singleton:
self.reset()
def reset(self):
self.stack = []
self.observers = []
def setup(self, parsed_args):
def show_progressbar():
# Show progress bar if user explicitly asked for it
if parsed_args.progress:
return True
# ... otherwise show it if STDOUT is a tty and we are not debugging
if parsed_args.progress is None:
return sys.stdout.isatty() and not parsed_args.debug
return False
log_handler = None
if show_progressbar():
try:
bar = ProgressBar()
self.register(bar)
log_handler = ProgressLoggingHandler(bar)
except ImportError:
# User asked for bar, so show them the error
if parsed_args.progress:
raise
if parsed_args.status_fd:
self.register(StatusFD(os.fdopen(parsed_args.status_fd, 'w')))
return log_handler
def push(self, progress):
assert not self.stack or self.stack[-1].is_active()
self.stack.append(progress)
def pop(self, progress):
x = self.stack.pop()
assert x is progress
if self.stack:
self.stack[-1].child_done(x.total)
def register(self, observer):
logger.debug("Registering %s as a progress observer", observer)
self.observers.append(observer)
def update(self, msg):
if self.stack:
cur_estimates = None
for progress in reversed(self.stack):
cur_estimates = progress.estimates(cur_estimates)
current, total = cur_estimates
else:
current, total = 0, 1
for x in self.observers:
x.notify(current, total, msg)
def finish(self):
for x in self.observers:
x.finish()
class Progress(object):
def __init__(self, total=None):
self.done = []
self.current_steps = None
self.current_child_steps_done = None
if total:
self.total = total
else:
self.total = 1
self.begin_step(1)
def __enter__(self):
ProgressManager().push(self)
return self
def __exit__(self, exc_type, exc_value, exc_traceback):
self.maybe_end()
ProgressManager().pop(self)
def estimates(self, cur_child_estimate=None):
own_done = sum(pair[0] for pair in self.done)
children_done = sum(pair[1] for pair in self.done)
all_done = own_done + children_done
if self.current_steps:
if self.current_child_steps_done or cur_child_estimate:
# Something is in-progress, the calculation is slightly more
# complex
cur_child_done, cur_child_total = cur_child_estimate or (0, 0)
own_done += self.current_steps
all_done += self.current_steps + \
self.current_child_steps_done + \
cur_child_done
# Cost of what we expect will have been done, once the current
# in-progress step plus all of its children, have completed
expected_all_done = all_done + \
(cur_child_total - cur_child_done)
assert own_done # non-zero
return all_done, int(float(self.total) / own_done
* expected_all_done)
else:
# nothing in progress
assert not cur_child_estimate
if not own_done:
assert not children_done
return 0, self.total
# weigh self.total by (all_done/own_done)
return all_done, int(float(self.total) / own_done * all_done)
def is_active(self):
return self.current_steps is not None
def maybe_end(self, msg=""):
if self.is_active():
self.done += [(self.current_steps, self.current_child_steps_done)]
self.current_steps = None
self.current_child_steps_done = None
ProgressManager().update(msg)
def begin_step(self, step, msg=""):
assert step is not None
self.maybe_end(msg)
self.current_steps = step
self.current_child_steps_done = 0
def child_done(self, total):
self.current_child_steps_done += total
class ProgressBar(object):
def __init__(self):
import progressbar
try:
from progressbar.widgets import WidgetBase
except ImportError:
# Fallback to the older Debian version
from progressbar import Widget as WidgetBase
self.msg = ""
class Message(WidgetBase):
def update(self, pbar, _observer=self):
msg = _observer.msg
width = 25
if len(msg) <= width:
return msg.rjust(width)
# Print the last `width` characters with an ellipsis.
return '…{}'.format(msg[-width + 1:])
class OurProgressBar(progressbar.ProgressBar):
def __init__(self, *args, **kwargs):
# Remove after https://github.com/niltonvolpato/python-progressbar/pull/57 is fixed.
kwargs.setdefault('fd', sys.stderr)
super().__init__(*args, **kwargs)
def _need_update(self):
return True
self.bar = OurProgressBar(widgets=(
' ',
progressbar.Bar(),
' ',
progressbar.Percentage(),
' ',
Message(),
' ',
progressbar.ETA(),
' ',
))
self.bar.start()
def notify(self, current, total, msg):
self.msg = msg
self.bar.maxval = total
self.bar.currval = current
self.bar.update()
def finish(self):
self.bar.finish()
class StatusFD(object):
def __init__(self, fileobj):
self.fileobj = fileobj
def notify(self, current, total, msg):
print(json.dumps({
'msg': msg,
'total': total,
'current': current,
}), file=self.fileobj)
def finish(self):
pass
|