Return FormWidget from WidgetBuilder.create_form

Add error window to `FormWidget`

Author: agoose77

qt_jsonschema_form/form.py

@@ -18,14 +18,14 @@ def get_schema_type(schema: dict) -> str:
 
 class WidgetBuilder:
     default_widget_map = {
-        "boolean": {"checkbox": widgets.CheckboxWidget, "enum": widgets.EnumWidget},
-        "object": {"object": widgets.ObjectWidget, "enum": widgets.EnumWidget},
-        "number": {"spin": widgets.SpinDoubleWidget, "text": widgets.TextWidget, "enum": widgets.EnumWidget},
-        "string": {"textarea": widgets.TextAreaWidget, "text": widgets.TextWidget, "password": widgets.PasswordWidget,
-                   "filepath": widgets.FilepathWidget, "colour": widgets.ColorWidget, "enum": widgets.EnumWidget},
-        "integer": {"spin": widgets.SpinWidget, "text": widgets.TextWidget, "range": widgets.IntegerRangeWidget,
-                    "enum": widgets.EnumWidget},
-        "array": {"array": widgets.ArrayWidget, "enum": widgets.EnumWidget}
+        "boolean": {"checkbox": widgets.CheckboxSchemaWidget, "enum": widgets.EnumSchemaWidget},
+        "object": {"object": widgets.ObjectSchemaWidget, "enum": widgets.EnumSchemaWidget},
+        "number": {"spin": widgets.SpinDoubleSchemaWidget, "text": widgets.TextSchemaWidget, "enum": widgets.EnumSchemaWidget},
+        "string": {"textarea": widgets.TextAreaSchemaWidget, "text": widgets.TextSchemaWidget, "password": widgets.PasswordWidget,
+                   "filepath": widgets.FilepathSchemaWidget, "colour": widgets.ColorSchemaWidget, "enum": widgets.EnumSchemaWidget},
+        "integer": {"spin": widgets.SpinSchemaWidget, "text": widgets.TextSchemaWidget, "range": widgets.IntegerRangeSchemaWidget,
+                    "enum": widgets.EnumSchemaWidget},
+        "array": {"array": widgets.ArraySchemaWidget, "enum": widgets.EnumSchemaWidget}
     }
 
     default_widget_variants = {
@@ -45,24 +45,31 @@ def __init__(self, validator_cls=None):
         self.widget_map = deepcopy(self.default_widget_map)
         self.validator_cls = validator_cls
 
-    def create_form(self, schema: dict, ui_schema: dict, state=None) -> widgets.WidgetMixin:
+    def create_form(self, schema: dict, ui_schema: dict, state=None) -> widgets.SchemaWidgetMixin:
         validator_cls = self.validator_cls
         if validator_cls is None:
             validator_cls = validator_for(schema)
 
         validator_cls.check_schema(schema)
         validator = validator_cls(schema)
-        widget = self.create_widget(schema, ui_schema, state)
+        schema_widget = self.create_widget(schema, ui_schema, state)
+        form = widgets.FormWidget(schema_widget)
 
         def validate(data):
-            for err in validator.iter_errors(data):
-                widget.handle_error(err.path, err)
+            form.clear_errors()
+            errors = [*validator.iter_errors(data)]
 
-        widget.on_changed.connect(validate)
+            if errors:
+                form.display_errors(errors)
 
-        return widget
+            for err in errors:
+                schema_widget.handle_error(err.path, err)
+
+        schema_widget.on_changed.connect(validate)
+
+        return form
 
-    def create_widget(self, schema: dict, ui_schema: dict, state=None) -> widgets.WidgetMixin:
+    def create_widget(self, schema: dict, ui_schema: dict, state=None) -> widgets.SchemaWidgetMixin:
         schema_type = get_schema_type(schema)
 
         try:

qt_jsonschema_form/widgets.py

@@ -8,7 +8,7 @@
 from .utils import iter_layout_widgets, state_property, is_concrete_schema
 
 
-class WidgetMixin:
+class SchemaWidgetMixin:
     on_changed = Signal()
 
     VALID_COLOUR = '#ffffff'
@@ -53,7 +53,7 @@ def _set_valid_state(self, error: Exception = None):
         self.setToolTip("" if error is None else error.message)  # TODO
 
 
-class TextWidget(WidgetMixin, QtWidgets.QLineEdit):
+class TextSchemaWidget(SchemaWidgetMixin, QtWidgets.QLineEdit):
 
     def configure(self):
         self.textChanged.connect(self.on_changed.emit)
@@ -67,15 +67,15 @@ def state(self, state: str):
         self.setText(state)
 
 
-class PasswordWidget(TextWidget):
+class PasswordWidget(TextSchemaWidget):
 
     def configure(self):
         super().configure()
 
         self.setEchoMode(self.Password)
 
 
-class TextAreaWidget(WidgetMixin, QtWidgets.QTextEdit):
+class TextAreaSchemaWidget(SchemaWidgetMixin, QtWidgets.QTextEdit):
 
     @state_property
     def state(self) -> str:
@@ -89,7 +89,7 @@ def configure(self):
         self.textChanged.connect(lambda: self.on_changed.emit(self.state))
 
 
-class CheckboxWidget(WidgetMixin, QtWidgets.QCheckBox):
+class CheckboxSchemaWidget(SchemaWidgetMixin, QtWidgets.QCheckBox):
 
     @state_property
     def state(self) -> bool:
@@ -103,7 +103,7 @@ def configure(self):
         self.stateChanged.connect(lambda _: self.on_changed.emit(self.state))
 
 
-class SpinDoubleWidget(WidgetMixin, QtWidgets.QDoubleSpinBox):
+class SpinDoubleSchemaWidget(SchemaWidgetMixin, QtWidgets.QDoubleSpinBox):
 
     @state_property
     def state(self) -> float:
@@ -117,7 +117,7 @@ def configure(self):
         self.valueChanged.connect(self.on_changed.emit)
 
 
-class SpinWidget(WidgetMixin, QtWidgets.QSpinBox):
+class SpinSchemaWidget(SchemaWidgetMixin, QtWidgets.QSpinBox):
 
     @state_property
     def state(self) -> int:
@@ -131,7 +131,7 @@ def configure(self):
         self.valueChanged.connect(self.on_changed.emit)
 
 
-class IntegerRangeWidget(WidgetMixin, QtWidgets.QSlider):
+class IntegerRangeSchemaWidget(SchemaWidgetMixin, QtWidgets.QSlider):
 
     def __init__(self, schema: dict, ui_schema: dict, widget_builder: 'WidgetBuilder'):
         super().__init__(schema, ui_schema, widget_builder, orientation=QtCore.Qt.Horizontal)
@@ -209,7 +209,7 @@ def mousePressEvent(self, event):
         return super(QColorButton, self).mousePressEvent(event)
 
 
-class ColorWidget(WidgetMixin, QColorButton):
+class ColorSchemaWidget(SchemaWidgetMixin, QColorButton):
     """Widget representation of a string with the 'color' format keyword."""
 
     def configure(self):
@@ -224,7 +224,7 @@ def state(self, data: str):
         self.setColor(data)
 
 
-class FilepathWidget(WidgetMixin, QtWidgets.QWidget):
+class FilepathSchemaWidget(SchemaWidgetMixin, QtWidgets.QWidget):
 
     def __init__(self, schema: dict, ui_schema: dict, widget_builder: 'WidgetBuilder'):
         super().__init__(schema, ui_schema, widget_builder)
@@ -298,7 +298,7 @@ def __init__(self, widget: QtWidgets.QWidget, controls: ArrayControlsWidget):
         self.controls = controls
 
 
-class ArrayWidget(WidgetMixin, QtWidgets.QWidget):
+class ArraySchemaWidget(SchemaWidgetMixin, QtWidgets.QWidget):
 
     @property
     def rows(self) -> List[ArrayRowWidget]:
@@ -434,7 +434,7 @@ def widget_on_changed(self, row: ArrayRowWidget, value):
         self.on_changed.emit(self.state)
 
 
-class ObjectWidget(WidgetMixin, QtWidgets.QGroupBox):
+class ObjectSchemaWidget(SchemaWidgetMixin, QtWidgets.QGroupBox):
 
     def __init__(self, schema: dict, ui_schema: dict, widget_builder: 'WidgetBuilder'):
         super().__init__(schema, ui_schema, widget_builder)
@@ -485,7 +485,7 @@ def populate_from_schema(self, schema: dict, ui_schema: dict, widget_builder: 'W
         return widgets
 
 
-class EnumWidget(WidgetMixin, QtWidgets.QComboBox):
+class EnumSchemaWidget(SchemaWidgetMixin, QtWidgets.QComboBox):
 
     @state_property
     def state(self):
@@ -507,5 +507,40 @@ def configure(self):
         self.currentIndexChanged.connect(lambda _: self.on_changed.emit(self.state))
 
     def _index_changed(self, index: int):
-        value = self.itemData(index)
-        self.on_changed.emit(self.state)
+        self.on_changed.emit(self.state)
+
+
+class FormWidget(QtWidgets.QWidget):
+
+    def __init__(self, widget):
+        super().__init__()
+        layout = QtWidgets.QVBoxLayout()
+        self.setLayout(layout)
+
+        self.error_widget = QtWidgets.QGroupBox()
+        self.error_widget.setTitle("Errors")
+        self.error_layout = QtWidgets.QVBoxLayout()
+        self.error_widget.setLayout(self.error_layout)
+        self.error_widget.hide()
+
+        layout.addWidget(self.error_widget)
+        layout.addWidget(widget)
+
+        self.widget = widget
+
+    def display_errors(self, errors: List[Exception]):
+        self.error_widget.show()
+
+        layout = self.error_widget.layout()
+        while True:
+            item = layout.takeAt(0)
+            if not item:
+                break
+            item.widget().deleteLater()
+
+        for err in errors:
+            widget = QtWidgets.QLabel(f"<b>.{'.'.join(err.path)}</b> {err.message}")
+            layout.addWidget(widget)
+
+    def clear_errors(self):
+        self.error_widget.hide()

test.py

@@ -61,8 +61,8 @@
         }
 
     }
-    w = wb.create_form(s, uis)
-    w.state = {
+    form = wb.create_form(s, uis)
+    form.state = {
         "schema_path": "/home/angus/PycharmProjects/qt-jsonschema-form/qt_jsonschema_form/__pycache__/__init__.cpython-37.pyc",
         "integerRangeSteps": 60,
         "sky_colour": "#8f5902",
@@ -71,9 +71,9 @@
             "Bob"
         ]
     }
-    w.show()
-    w.on_changed.connect(lambda d: print(dumps(d, indent=4)))
+    form.show()
+    form.widget.on_changed.connect(lambda d: print(dumps(d, indent=4)))
 
-    print(w)
+    print(form)
     app.exec_()