libervia-backend: libervia/frontends/tools/xmlui.py comparison

comparison libervia/frontends/tools/xmlui.py @ 4270:0d7bb4df2343

Reformatted code base using black.

author	Goffi <goffi@goffi.org>
date	Wed, 19 Jun 2024 18:44:57 +0200
parents	26b7ed2817da
children

comparison

equal deleted inserted replaced

-:64a85ce8be70
+:0d7bb4df2343
 """Base class to construct SàT XML User Interface
 This class must not be instancied directly
 """
-def __init__(self, host, parsed_dom, title=None, flags=None, callback=None,
+def __init__(
-profile=C.PROF_KEY_NONE):
+self,
+host,
+parsed_dom,
+title=None,
+flags=None,
+callback=None,
+profile=C.PROF_KEY_NONE,
+):
 """Initialise the XMLUI instance
 @param host: %(doc_host)s
 @param parsed_dom: main parsed dom
 @param title: force the title, or use XMLUI one if None
 raise NotImplementedError
 class ValueGetter(object):
 """dict like object which return values of widgets"""
 # FIXME: widget which can keep multiple values are not handled
 def __init__(self, widgets, attr="value"):
 self.attr = attr
 self.widgets = widgets
 @property dialog_factory: factory to create frontend-specific dialogs
 """
 widget_factory = None
-def __init__(self, host, parsed_dom, title=None, flags=None, callback=None,
+def __init__(
-ignore=None, whitelist=None, profile=C.PROF_KEY_NONE):
+self,
+host,
+parsed_dom,
+title=None,
+flags=None,
+callback=None,
+ignore=None,
+whitelist=None,
+profile=C.PROF_KEY_NONE,
+):
 """
 @param title(unicode, None): title of the
 @property widgets(dict): widget name => widget map
 @property widget_value(ValueGetter): retrieve widget value from it's name
 def main_cont(self, value):
 if self._main_cont is not None:
 raise ValueError(_("XMLUI can have only one main container"))
 self._main_cont = value
-def _parse_childs(self, _xmlui_parent, current_node, wanted=("container",), data=None):
+def _parse_childs(
+self, _xmlui_parent, current_node, wanted=("container",), data=None
+):
 """Recursively parse childNodes of an element
 @param _xmlui_parent: widget container with '_xmlui_append' method
 @param current_node: element from which childs will be parsed
 @param wanted: list of tag names that can be present in the childs to be SàT XMLUI
 self._parse_childs(
 # FIXME: the "None" value for CURRENT_LABEL doesn't seem
 #        used or even useful, it should probably be removed
 #        and all "is not None" tests for it should be removed too
 #        to be checked for 0.8
-cont, node, ("widget", "container"), {CURRENT_LABEL: None}
+cont,
+node,
+("widget", "container"),
+{CURRENT_LABEL: None},
 )
 elif type_ == "advanced_list":
 try:
 columns = int(node.getAttribute("columns"))
 except (TypeError, ValueError):
 label = node.getAttribute("label")
 selected = C.bool(node.getAttribute("selected") or C.BOOL_FALSE)
 if not name or not "tabs_cont" in data:
 raise InvalidXMLUI
 if self.type == "param":
-self._current_category = (
+self._current_category = name  # XXX: awful hack because params need category and we don't keep parent
-name
-)  # XXX: awful hack because params need category and we don't keep parent
 tab_cont = data["tabs_cont"]
 new_tab = tab_cont._xmlui_add_tab(label or name, selected)
 self._parse_childs(new_tab, node, ("widget", "container"))
 elif node.nodeName == "row":
 elif type_ == "label":
 ctrl = self.widget_factory.createLabelWidget(_xmlui_parent, value)
 data[CURRENT_LABEL] = ctrl
 elif type_ == "hidden":
 if name in self.hidden:
-raise exceptions.ConflictError("Conflict on hidden value with "
+raise exceptions.ConflictError(
-"name {name}".format(name=name))
+"Conflict on hidden value with "
+"name {name}".format(name=name)
+)
 self.hidden[name] = value
 continue
 elif type_ == "jid":
 ctrl = self.widget_factory.createJidWidget(_xmlui_parent, value)
 elif type_ == "divider":
 @param class_: the class to use to instanciate given type
 """
 # TODO: remove this method, as there are seme use cases where different XMLUI
 #       classes can be used in the same frontend, so a global value is not good
 assert type_ in (CLASS_PANEL, CLASS_DIALOG)
-log.warning("register_class for XMLUI is deprecated, please use partial with "
+log.warning(
-"xmlui.create and class_map instead")
+"register_class for XMLUI is deprecated, please use partial with "
+"xmlui.create and class_map instead"
+)
 if type_ in _class_map:
-log.debug(_("XMLUI class already registered for {type_}, ignoring").format(
+log.debug(
-type_=type_))
+_("XMLUI class already registered for {type_}, ignoring").format(type_=type_)
+)
 return
 _class_map[type_] = class_
-def create(host, xml_data, title=None, flags=None, dom_parse=None, dom_free=None,
+def create(
-callback=None, ignore=None, whitelist=None, class_map=None,
+host,
-profile=C.PROF_KEY_NONE):
+xml_data,
+title=None,
+flags=None,
+dom_parse=None,
+dom_free=None,
+callback=None,
+ignore=None,
+whitelist=None,
+class_map=None,
+profile=C.PROF_KEY_NONE,
+):
 """
 @param dom_parse: methode equivalent to minidom.parseString (but which must manage unicode), or None to use default one
 @param dom_free: method used to free the parsed DOM
 @param ignore(list[unicode], None): name of widgets to ignore
 widgets with name in this list and their label will be ignored
 @param whitelist(list[unicode], None): name of widgets to keep
 when not None, only widgets in this list and their label will be kept
 mutually exclusive with ignore
 """
 if class_map is None:
 class_map = _class_map
 if dom_parse is None:
 from xml.dom import minidom

Mercurial > libervia-backend

comparison libervia/frontends/tools/xmlui.py @ 4270:0d7bb4df2343