libervia-backend/sat_frontends/primitivus/progress.py
Goffi 6a6f15707a massive refactoring to switch from camelCase to snake_case:
historically, Libervia (SàT before) was using camelCase as allowed by PEP8 when using a
pre-PEP8 code, to use the same coding style as in Twisted.

However, snake_case is more readable and it's better to follow PEP8 best practices, so it
has been decided to move on full snake_case. Because Libervia has a huge codebase, this
ended with a ugly mix of camelCase and snake_case.

To fix that, this patch does a big refactoring by renaming every function and method
(including bridge) that are not coming from Twisted or Wokkel, to use fully snake_case.

This is a massive change, and may result in some bugs.
2023-04-08 13:54:42 +02:00

101 lines
4.1 KiB
Python

#!/usr/bin/env python3
# Primitivus: a SAT frontend
# Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
from sat.core.i18n import _
import urwid
from urwid_satext import sat_widgets
from sat_frontends.quick_frontend import quick_widgets
class Progress(urwid.WidgetWrap, quick_widgets.QuickWidget):
PROFILES_ALLOW_NONE = True
def __init__(self, host, target, profiles):
assert target is None and profiles is None
quick_widgets.QuickWidget.__init__(self, host, target)
self.host = host
self.progress_list = urwid.SimpleListWalker([])
self.progress_dict = {}
listbox = urwid.ListBox(self.progress_list)
buttons = []
buttons.append(sat_widgets.CustomButton(_("Clear progress list"), self._on_clear))
max_len = max([button.get_size() for button in buttons])
buttons_wid = urwid.GridFlow(buttons, max_len, 1, 0, "center")
main_wid = sat_widgets.FocusFrame(listbox, footer=buttons_wid)
urwid.WidgetWrap.__init__(self, main_wid)
def add(self, progress_id, message, profile):
mess_wid = urwid.Text(message)
progr_wid = urwid.ProgressBar("progress_normal", "progress_complete")
column = urwid.Columns([mess_wid, progr_wid])
self.progress_dict[(progress_id, profile)] = {
"full": column,
"progress": progr_wid,
"state": "init",
}
self.progress_list.append(column)
self.progress_cb(self.host.loop, (progress_id, message, profile))
def progress_cb(self, loop, data):
progress_id, message, profile = data
data = self.host.bridge.progress_get(progress_id, profile)
pbar = self.progress_dict[(progress_id, profile)]["progress"]
if data:
if self.progress_dict[(progress_id, profile)]["state"] == "init":
# first answer, we must construct the bar
self.progress_dict[(progress_id, profile)]["state"] = "progress"
pbar.done = float(data["size"])
pbar.set_completion(float(data["position"]))
self.update_not_bar()
else:
if self.progress_dict[(progress_id, profile)]["state"] == "progress":
self.progress_dict[(progress_id, profile)]["state"] = "done"
pbar.set_completion(pbar.done)
self.update_not_bar()
return
loop.set_alarm_in(0.2, self.progress_cb, (progress_id, message, profile))
def _remove_bar(self, progress_id, profile):
wid = self.progress_dict[(progress_id, profile)]["full"]
self.progress_list.remove(wid)
del (self.progress_dict[(progress_id, profile)])
def _on_clear(self, button):
to_remove = []
for progress_id, profile in self.progress_dict:
if self.progress_dict[(progress_id, profile)]["state"] == "done":
to_remove.append((progress_id, profile))
for progress_id, profile in to_remove:
self._remove_bar(progress_id, profile)
self.update_not_bar()
def update_not_bar(self):
if not self.progress_dict:
self.host.set_progress(None)
return
progress = 0
nb_bars = 0
for progress_id, profile in self.progress_dict:
pbar = self.progress_dict[(progress_id, profile)]["progress"]
progress += pbar.current / pbar.done * 100
nb_bars += 1
av_progress = progress / float(nb_bars)
self.host.set_progress(av_progress)