libervia-backend: sat_frontends/jp/xmlui

comparison sat_frontends/jp/xmlui_manager.py @ 3040:fee60f17ebac

jp: jp asyncio port: /!\ this commit is huge. Jp is temporarily not working with `dbus` bridge /!\ This patch implements the port of jp to asyncio, so it is now correctly using the bridge asynchronously, and it can be used with bridges like `pb`. This also simplify the code, notably for things which were previously implemented with many callbacks (like pagination with RSM). During the process, some behaviours have been modified/fixed, in jp and backends, check diff for details.

author	Goffi <goffi@goffi.org>
date	Wed, 25 Sep 2019 08:56:41 +0200
parents	ab2696e34d29
children	d909473a76cc

comparison

equal deleted inserted replaced

-:a1bc34f90fa5
+:fee60f17ebac
 # 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 functools import partial
 from sat.core.log import getLogger
-log = getLogger(__name__)
 from sat_frontends.tools import xmlui as xmlui_base
 from sat_frontends.jp.constants import Const as C
 from sat.tools.common.ansi import ANSI as A
 from sat.core.i18n import _
-from functools import partial
+log = getLogger(__name__)
 # workflow constants
 SUBMIT = "SUBMIT"  # submit form
 @property
 def name(self):
 return self._xmlui_name
-def show(self):
+async def show(self):
 """display current widget
 must be overriden by subclasses
 """
 raise NotImplementedError(self.__class__)
 class EmptyWidget(xmlui_base.EmptyWidget, Widget):
 def __init__(self, xmlui_parent):
 Widget.__init__(self, xmlui_parent)
-def show(self):
+async def show(self):
 self.host.disp('')
 class TextWidget(xmlui_base.TextWidget, ValueWidget):
 type = "text"
-def show(self):
+async def show(self):
 self.host.disp(self.value)
 class LabelWidget(xmlui_base.LabelWidget, ValueWidget):
 type = "label"
 try:
 return self._xmlui_for_name
 except AttributeError:
 return None
-def show(self, no_lf=False, ansi=""):
+async def show(self, no_lf=False, ansi=""):
 """show label
 @param no_lf(bool): same as for [JP.disp]
 @param ansi(unicode): ansi escape code to print before label
 """
 type = "jid"
 class StringWidget(xmlui_base.StringWidget, InputWidget):
 type = "string"
-def show(self):
+async def show(self):
 if self.read_only or self.root.read_only:
 self.disp(self.value)
 else:
 elems = []
 self.verboseName(elems)
 if self.value:
-elems.append(_("(enter: {default})").format(default=self.value))
+elems.append(_(f"(enter: {self.value})"))
 elems.extend([C.A_HEADER, "> "])
-value = input(A.color(*elems).encode('utf-8'))
+value = await self.host.ainput(A.color(*elems))
 if value:
 #  TODO: empty value should be possible
 #       an escape key should be used for default instead of enter with empty value
 self.value = value
 class TextBoxWidget(xmlui_base.TextWidget, StringWidget):
 type = "textbox"
 # TODO: use a more advanced input method
-def show(self):
+async def show(self):
 self.verboseName()
 if self.read_only or self.root.read_only:
 self.disp(self.value)
 else:
 if self.value:
 values = []
 while True:
 try:
 if not values:
-line = input(A.color(C.A_HEADER, "[Ctrl-D to finish]> "))
+line = await self.host.ainput(A.color(C.A_HEADER, "[Ctrl-D to finish]> "))
 else:
-line = input()
+line = await self.host.ainput()
 values.append(line)
 except EOFError:
 break
 self.value = '\n'.join(values).rstrip()
 class XHTMLBoxWidget(xmlui_base.XHTMLBoxWidget, StringWidget):
 type = "xhtmlbox"
-def show(self):
+async def show(self):
 # FIXME: we use bridge in a blocking way as permitted by python-dbus
 #        this only for now to make it simpler, it must be refactored
 #        to use async when jp will be fully async (expected for 0.8)
-self.value = self.host.bridge.syntaxConvert(
+self.value = await self.host.bridge.syntaxConvert(
 self.value, C.SYNTAX_XHTML, "markdown", False, self.host.profile)
-super(XHTMLBoxWidget, self).show()
+await super(XHTMLBoxWidget, self).show()
 class ListWidget(xmlui_base.ListWidget, OptionsWidget):
 type = "list"
 # TODO: handle flags, notably multi
-def show(self):
+async def show(self):
 if self.root.values_only:
 for value in self.values:
 self.disp(self.value)
 return
 if not self.options:
 #  we ask use to choose an option
 choice = None
 limit_max = len(self.options) - 1
 while choice is None or choice < 0 or choice > limit_max:
-choice = input(
+choice = await self.host.ainput(
-A.color(C.A_HEADER, _("your choice (0-{max}): ").format(max=limit_max))
+A.color(C.A_HEADER, _(f"your choice (0-{limit_max}): "))
 )
 try:
 choice = int(choice)
 except ValueError:
 choice = None
 class BoolWidget(xmlui_base.BoolWidget, InputWidget):
 type = "bool"
-def show(self):
+async def show(self):
 disp_true = A.color(A.FG_GREEN, "TRUE")
 disp_false = A.color(A.FG_RED, "FALSE")
 if self.read_only or self.root.read_only:
 self.disp(disp_true if self.value else disp_false)
 else:
 " *" if self.value else ""))
 choice = None
 while choice not in ("0", "1"):
 elems = [C.A_HEADER, _("your choice (0,1): ")]
 self.verboseName(elems)
-choice = input(A.color(*elems))
+choice = await self.host.ainput(A.color(*elems))
 self.value = bool(int(choice))
 self.disp("")
 def _xmluiGetValue(self):
 return C.boolConst(self.value)
 self.children.append(widget)
 def _xmluiRemove(self, widget):
 self.children.remove(widget)
-def show(self):
+async def show(self):
 for child in self.children:
-child.show()
+await child.show()
 class VerticalContainer(xmlui_base.VerticalContainer, Container):
 type = "vertical"
 class LabelContainer(xmlui_base.PairsContainer, Container):
 type = "label"
-def show(self):
+async def show(self):
 for child in self.children:
 no_lf = False
 # we check linked widget type
 # to see if we want the label on the same line or not
 if child.type == "label":
 "jid_input",
 ):
 no_lf = True
 elif wid_type == "bool" and for_widget.read_only:
 no_lf = True
-child.show(no_lf=no_lf, ansi=A.FG_CYAN)
+await child.show(no_lf=no_lf, ansi=A.FG_CYAN)
 else:
-child.show()
+await child.show()
 ## Dialogs ##
 self.host = self.xmlui_parent.host
 def disp(self, *args, **kwargs):
 self.host.disp(*args, **kwargs)
-def show(self):
+async def show(self):
 """display current dialog
 must be overriden by subclasses
 """
 raise NotImplementedError(self.__class__)
+class MessageDialog(xmlui_base.MessageDialog, Dialog):
+def __init__(self, xmlui_parent, title, message, level):
+Dialog.__init__(self, xmlui_parent)
+xmlui_base.MessageDialog.__init__(self, xmlui_parent)
+self.title, self.message, self.level = title, message, level
+async def show(self):
+# TODO: handle level
+if self.title:
+self.disp(A.color(C.A_HEADER, self.title))
+self.disp(self.message)
 class NoteDialog(xmlui_base.NoteDialog, Dialog):
-def show(self):
-# TODO: handle title and level
-self.disp(self.message)
 def __init__(self, xmlui_parent, title, message, level):
 Dialog.__init__(self, xmlui_parent)
 xmlui_base.NoteDialog.__init__(self, xmlui_parent)
 self.title, self.message, self.level = title, message, level
+async def show(self):
+# TODO: handle title and level
+self.disp(self.message)
+class ConfirmDialog(xmlui_base.ConfirmDialog, Dialog):
+def __init__(self, xmlui_parent, title, message, level, buttons_set):
+Dialog.__init__(self, xmlui_parent)
+xmlui_base.ConfirmDialog.__init__(self, xmlui_parent)
+self.title, self.message, self.level, self.buttons_set = (
+title, message, level, buttons_set)
+async def show(self):
+# TODO: handle buttons_set and level
+self.disp(self.message)
+if self.title:
+self.disp(A.color(C.A_HEADER, self.title))
+input_ = None
+while input_ not in ('y', 'n'):
+input_ = await self.host.ainput(f"{self.message} (y/n)? ")
+input_ = input_.lower()
+if input_ == 'y':
+self._xmluiValidated()
+else:
+self._xmluiCancelled()
 ## Factory ##
 if attr.startswith("create"):
 cls = globals()[attr[6:]]
 return cls
-class XMLUIPanel(xmlui_base.XMLUIPanel):
+class XMLUIPanel(xmlui_base.AIOXMLUIPanel):
 widget_factory = WidgetFactory()
 _actions = 0  # use to keep track of bridge's launchAction calls
 read_only = False
 values_only = False
 workflow = None
 @property
 def command(self):
 return self.host.command
-def show(self, workflow=None, read_only=False, values_only=False):
+async def show(self, workflow=None, read_only=False, values_only=False):
 """display the panel
 @param workflow(list, None): command to execute if not None
 put here for convenience, the main workflow is the class attribute
 (because workflow can continue in subclasses)
 if self.values_only:
 self.read_only = True
 if workflow:
 XMLUIPanel.workflow = workflow
 if XMLUIPanel.workflow:
-self.runWorkflow()
+await self.runWorkflow()
 else:
-self.main_cont.show()
+await self.main_cont.show()
-def runWorkflow(self):
+async def runWorkflow(self):
 """loop into workflow commands and execute commands
 SUBMIT will interrupt workflow (which will be continue on callback)
 @param workflow(list): same as [show]
 """
 try:
 cmd = workflow.pop(0)
 except IndexError:
 break
 if cmd == SUBMIT:
-self.onFormSubmitted()
+await self.onFormSubmitted()
 self.submit_id = None  # avoid double submit
 return
 elif isinstance(cmd, list):
 name, value = cmd
 widget = self.widgets[name]
 if widget.type == "bool":
 value = C.bool(value)
 widget.value = value
-self.show()
+await self.show()
-def submitForm(self, callback=None):
+async def submitForm(self, callback=None):
 XMLUIPanel._submit_cb = callback
-self.onFormSubmitted()
+await self.onFormSubmitted()
-def onFormSubmitted(self, ignore=None):
+async def onFormSubmitted(self, ignore=None):
-#  self.submitted is a Q&D workaround to avoid
+# self.submitted is a Q&D workaround to avoid
 # double submit when a workflow is set
 if self.submitted:
 return
 self.submitted = True
-super(XMLUIPanel, self).onFormSubmitted(ignore)
+await super(XMLUIPanel, self).onFormSubmitted(ignore)
 def _xmluiClose(self):
 pass
-def _launchActionCb(self, data):
+async def _launchActionCb(self, data):
 XMLUIPanel._actions -= 1
 assert XMLUIPanel._actions >= 0
 if "xmlui" in data:
 xmlui_raw = data["xmlui"]
 xmlui = create(self.host, xmlui_raw)
-xmlui.show()
+await xmlui.show()
 if xmlui.submit_id:
-xmlui.onFormSubmitted()
+await xmlui.onFormSubmitted()
 # TODO: handle data other than XMLUI
 if not XMLUIPanel._actions:
 if self._submit_cb is None:
 self.host.quit()
 else:
 self._submit_cb()
-def _xmluiLaunchAction(self, action_id, data):
+async def _xmluiLaunchAction(self, action_id, data):
 XMLUIPanel._actions += 1
-self.host.bridge.launchAction(
+try:
-action_id,
+data = await self.host.bridge.launchAction(
-data,
+action_id,
-self.profile,
+data,
-callback=self._launchActionCb,
+self.profile,
-errback=partial(
+)
-self.command.errback,
+except Exception as e:
-msg=_("can't launch XMLUI action: {}"),
+self.disp(f"can't launch XMLUI action: {e}", error=True)
-exit_code=C.EXIT_BRIDGE_ERRBACK,
+self.host.quit(C.EXIT_BRIDGE_ERRBACK)
-),
+else:
-)
+await self._launchActionCb(data)
 class XMLUIDialog(xmlui_base.XMLUIDialog):
 type = "dialog"
 dialog_factory = WidgetFactory()
 read_only = False
-def show(self, __=None):
+async def show(self, __=None):
-self.dlg.show()
+await self.dlg.show()
 def _xmluiClose(self):
 pass

Mercurial > libervia-backend

comparison sat_frontends/jp/xmlui_manager.py @ 3040:fee60f17ebac