libervia-backend: sat/tools/xml

comparison sat/tools/xml_tools.py @ 2625:a55a14c3cbf4

plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code

author	Goffi <goffi@goffi.org>
date	Wed, 27 Jun 2018 21:15:34 +0200
parents	56f94936df1e
children	c274201cea94

comparison

equal deleted inserted replaced

-:56f94936df1e
+:a55a14c3cbf4
 def _dataFormField2XMLUIData(field, read_only=False):
 """Get data needed to create an XMLUI's Widget from Wokkel's data_form's Field.
 The attribute field can be modified (if it's fixed and it has no value).
-@param field (data_form.Field): a field with attributes "value", "fieldType", "label" and "var"
+@param field (data_form.Field): a field with attributes "value", "fieldType",
+"label" and "var"
 @param read_only (bool): if True and it makes sense, create a read only input widget
 @return: a tuple (widget_type, widget_args, widget_kwargs)
 """
 widget_args = [field.value]
 widget_kwargs = {}
 @param items: list of widgets to add (just the first row)
 @param columns: number of columns in this table, or None to autodetect
 @param selectable: one of:
 'no': nothing is done
 'single': one row can be selected
-@param auto_index: if True, indexes will be generated by frontends, starting from 0
+@param auto_index: if True, indexes will be generated by frontends,
+starting from 0
 @return: created element
 """
 assert selectable in ("no", "single")
 if not items and columns is None:
 raise exceptions.DataError(_("either items or columns need do be filled"))
 """
 @param xmlui
 @param options (list[option]): each option can be given as:
 - a single string if the label and the value are the same
-- a tuple with a couple of string (value,label) if the label and the value differ
+- a tuple with a couple of string (value,label) if the label and the
+value differ
 @param selected (list[string]): list of the selected values
 @param styles (iterable[string]): flags to set the behaviour of the list
 can be:
 - multi: multiple selection is allowed
 - noselect: no selection is allowed
 useful when only the list itself is needed
 - extensible: can be extended by user (i.e. new options can be added)
 - reducible: can be reduced by user (i.e. options can be removed)
-- inline: hint that this list should be displayed on a single line (e.g. list of labels)
+- inline: hint that this list should be displayed on a single line
+(e.g. list of labels)
 @param name (string)
 @param parent
 """
 styles = set() if styles is None else set(styles)
 if styles is None:
 else:
 styles = set(styles)
 if u"noselect" in styles and (u"multi" in styles or selected):
 raise exceptions.DataError(
 _(
-u'"multi" flag and "selected" option are not compatible with "noselect" flag'
+u'"multi" flag and "selected" option are not compatible with '
+u'"noselect" flag'
 )
 )
 if not options:
 # we can have no options if we get a submitted data form
 # but we can't use submitted values directly,
 class XMLUI(object):
 """This class is used to create a user interface (form/window/parameters/etc) using SàT XML"""
-def __init__(
+def __init__(self, panel_type="window", container="vertical", dialog_opt=None,
-self,
+title=None, submit_id=None, session_id=None):
-panel_type="window",
-container="vertical",
-dialog_opt=None,
-title=None,
-submit_id=None,
-session_id=None,
-):
 """Init SàT XML Panel
 @param panel_type: one of
 - C.XMLUI_WINDOW (new window)
 - C.XMLUI_POPUP
-- C.XMLUI_FORM (form, depend of the frontend, usually a panel with cancel/submit buttons)
+- C.XMLUI_FORM (form, depend of the frontend, usually a panel with
+cancel/submit buttons)
 - C.XMLUI_PARAM (parameters, presentation depend of the frontend)
 - C.XMLUI_DIALOG (one common dialog, presentation depend of frontend)
 @param container: disposition of elements, one of:
 - vertical: elements are disposed up to bottom
 - horizontal: elements are disposed left to right
 - pairs: elements come on two aligned columns
 (usually one for a label, the next for the element)
 - label: associations of one LabelWidget or EmptyWidget with an other widget
-similar to pairs but specialized in LabelWidget, and not necessarily arranged in 2 columns
+similar to pairs but specialized in LabelWidget,
+and not necessarily arranged in 2 columns
 - tabs: elemens are in categories with tabs (notebook)
-@param dialog_opt: only used if panel_type == C.XMLUI_DIALOG. Dictionnary (string/string) where key can be:
+@param dialog_opt: only used if panel_type == C.XMLUI_DIALOG.
+Dictionnary (string/string) where key can be:
 - C.XMLUI_DATA_TYPE: type of dialog, value can be:
-- C.XMLUI_DIALOG_MESSAGE (default): an information/error message. Action of user is necessary to close the dialog. Usually the frontend display a classic popup
+- C.XMLUI_DIALOG_MESSAGE (default): an information/error message.
-- C.XMLUI_DIALOG_NOTE: like a C.XMLUI_DIALOG_MESSAGE, but action of user is not necessary to close, at frontend choice (it can be closed after a timeout). Usually the frontend display as a timed out notification
+Action of user is necessary to close the dialog.
+Usually the frontend display a classic popup.
+- C.XMLUI_DIALOG_NOTE: like a C.XMLUI_DIALOG_MESSAGE, but action of user
+is not necessary to close, at frontend choice (it can be closed after
+a timeout). Usually the frontend display as a timed out notification
 - C.XMLUI_DIALOG_CONFIRM: dialog with 2 choices (usualy "Ok"/"Cancel").
 returned data can contain:
-- "answer": "true" if answer is "ok", "yes" or equivalent, "false" else
+- "answer": "true" if answer is "ok", "yes" or equivalent,
+"false" else
 - C.XLMUI_DIALOG_FILE: a file selection dialog
 returned data can contain:
-- "cancelled": "true" if dialog has been cancelled, not present or "false" else
+- "cancelled": "true" if dialog has been cancelled, not present
+or "false" else
 - "path": path of the choosed file/dir
 - C.XMLUI_DATA_MESS: message shown in dialog
 - C.XMLUI_DATA_LVL: one of:
 - C.XMLUI_DATA_LVL_INFO (default): normal message
 - C.XMLUI_DATA_LVL_WARNING: attention of user is important
 - C.XMLUI_DATA_LVL_ERROR: something went wrong
 - C.XMLUI_DATA_BTNS_SET: one of:
-- C.XMLUI_DATA_BTNS_SET_OKCANCEL (default): classical "OK" and "Cancel" set
+- C.XMLUI_DATA_BTNS_SET_OKCANCEL (default): classical "OK" and "Cancel"
-- C.XMLUI_DATA_BTNS_SET_YESNO: a translated "yes" for OK, and "no" for Cancel
+set
+- C.XMLUI_DATA_BTNS_SET_YESNO: a translated "yes" for OK, and "no" for
+Cancel
 - C.XMLUI_DATA_FILETYPE: only used for file dialogs, one of:
 - C.XMLUI_DATA_FILETYPE_FILE: a file path is requested
 - C.XMLUI_DATA_FILETYPE_DIR: a dir path is requested
 - C.XMLUI_DATA_FILETYPE_DEFAULT: same as C.XMLUI_DATA_FILETYPE_FILE
 @param title: title or default if None
-@param submit_id: callback id to call for panel_type we can submit (form, param, dialog)
+@param submit_id: callback id to call for panel_type we can submit (form, param,
-@param session_id: use to keep a session attached to the dialog, must be returned by frontends
+dialog)
+@param session_id: use to keep a session attached to the dialog, must be
+returned by frontends
 @attribute named_widgets(dict): map from name to widget
 """
 self._introspect()  # FIXME: why doing that on each XMLUI ? should be done once
 if panel_type not in [
 C.XMLUI_WINDOW,
 xmlui.submit_id = host.registerCallback(onSubmit, with_data=True, one_shot=True)
 return xmlui_d
-def deferXMLUI(
+def deferXMLUI(host, xmlui, action_extra=None, security_limit=C.NO_SECURITY_LIMIT,
-host,
+chained=False, profile=C.PROF_KEY_NONE):
-xmlui,
-action_extra=None,
-security_limit=C.NO_SECURITY_LIMIT,
-chained=False,
-profile=C.PROF_KEY_NONE,
-):
 """Create a deferred linked to XMLUI
 @param xmlui(XMLUI): instance of the XMLUI
 Must be an XMLUI that you can submit, with submit_id set to ''
 @param profile: %(doc_profile)s
 profile=profile,
 )
 return xmlui_d
-def deferDialog(
+def deferDialog(host, message, title=u"Please confirm", type_=C.XMLUI_DIALOG_CONFIRM,
-host,
+options=None, action_extra=None, security_limit=C.NO_SECURITY_LIMIT, chained=False,
-message,
+profile=C.PROF_KEY_NONE):
-title=u"Please confirm",
-type_=C.XMLUI_DIALOG_CONFIRM,
-options=None,
-action_extra=None,
-security_limit=C.NO_SECURITY_LIMIT,
-chained=False,
-profile=C.PROF_KEY_NONE,
-):
 """Create a submitable dialog and manage it with a deferred
 @param message(unicode): message to display
 @param title(unicode): title of the dialog
 @param type(unicode): dialog type (C.XMLUI_DIALOG_*)
-@param options(None, dict): if not None, will be used to update (extend) dialog_opt arguments of XMLUI
+@param options(None, dict): if not None, will be used to update (extend) dialog_opt
+arguments of XMLUI
 @param action_extra(None, dict): extra action to merge with xmlui
 mainly used to add meta informations (see actionNew doc)
 @param security_limit: %(doc_security_limit)s
 @param chained(bool): True if the Deferred result must be returned to the frontend
 useful when backend is in a series of dialogs with an ui
 return u""
 def __call__(self, raw_xml, force_spaces=False, namespace=None):
 """
 @param raw_xml(unicode): the raw XML
-@param force_spaces (bool): if True, replace occurrences of '\n' and '\t' with ' '.
+@param force_spaces (bool): if True, replace occurrences of '\n' and '\t'
-@param namespace(unicode, None): if set, use this namespace for the wrapping element
+with ' '.
+@param namespace(unicode, None): if set, use this namespace for the wrapping
+element
 """
 # we need to wrap element in case
 # there is not a unique one on the top
 if namespace is not None:
 raw_xml = u"<div xmlns='{}'>{}</div>".format(namespace, raw_xml)

Mercurial > libervia-backend

comparison sat/tools/xml_tools.py @ 2625:a55a14c3cbf4