Merge pull request #1008 from ess-dmsc/ECDC-2433_attrs_tree_view

ECDC-2433: Adding view attributes button in main window

Author: kmurica

nexus_constructor/field_attrs.py

@@ -1,7 +1,8 @@
 from functools import partial
-from typing import Any, Union
+from typing import Any, List, Union
 
 import numpy as np
+from PySide6.QtCore import Signal
 from PySide6.QtWidgets import (
     QComboBox,
     QDialog,
@@ -16,7 +17,8 @@
 
 from nexus_constructor.array_dataset_table_widget import ArrayDatasetTableWidget
 from nexus_constructor.common_attrs import ARRAY, SCALAR, CommonAttrs
-from nexus_constructor.model.module import Dataset
+from nexus_constructor.model import Group
+from nexus_constructor.model.module import FileWriterModule
 from nexus_constructor.model.value_type import VALUE_TYPE_TO_NP, ValueTypes
 from nexus_constructor.ui_utils import validate_line_edit
 from nexus_constructor.validators import AttributeNameValidator, FieldValueValidator
@@ -32,9 +34,14 @@ def _get_human_readable_type(new_value: Any):
     elif isinstance(new_value, float):
         return ValueTypes.DOUBLE
     else:
-        return next(
-            key for key, value in VALUE_TYPE_TO_NP.items() if value == new_value.dtype
-        )
+        try:
+            return next(
+                key
+                for key, value in VALUE_TYPE_TO_NP.items()
+                if value == new_value.dtype
+            )
+        except AttributeError:
+            return None
 
 
 class FieldAttrsDialog(QDialog):
@@ -49,17 +56,27 @@ def __init__(self, parent=None):
         self.add_button.clicked.connect(self.__add_attr)
         self.remove_button = QPushButton("Remove attr")
         self.remove_button.clicked.connect(self._remove_attrs)
+        self.close_button = QPushButton("OK")
+        self.close_button.clicked.connect(self.close)
 
-        self.layout().addWidget(self.list_widget, 0, 0, 2, 1)
+        self.layout().addWidget(self.list_widget, 0, 0, 3, 1)
         self.layout().addWidget(self.add_button, 0, 1)
         self.layout().addWidget(self.remove_button, 1, 1)
+        self.layout().addWidget(self.close_button, 2, 1)
 
-    def fill_existing_attrs(self, existing_dataset: Dataset):
+    def fill_existing_attrs(
+        self,
+        existing_dataset: Union[FileWriterModule, Group],
+        attributes_exclude: List = ATTRS_EXCLUDELIST,
+    ):
         for attr in existing_dataset.attributes:
-            if attr.name not in ATTRS_EXCLUDELIST:
+            if attr.name not in attributes_exclude:
                 frame = FieldAttrFrame(attr)
                 self._add_attr(existing_frame=frame)
 
+    def add_update_signal(self):
+        self.close_button.clicked.connect(self.update_attributes)
+
     def __add_attr(self):
         """
         Only used for button presses. Any additional arguments from the signal are ignored.
@@ -78,6 +95,19 @@ def _remove_attrs(self):
         for index in self.list_widget.selectedIndexes():
             self.list_widget.takeItem(index.row())
 
+    def update_attributes(self):
+        self.update_attributes_signal.emit(self.get_attrs())
+
+    def set_view_only(self, label: str, set_visibility: bool):
+        for index in range(self.list_widget.count()):
+            item = self.list_widget.item(index)
+            widget = self.list_widget.itemWidget(item)
+            widget.array_edit_button.setText(label)
+            widget.dialog.add_row_button.setVisible(set_visibility)
+            widget.dialog.remove_row_button.setVisible(set_visibility)
+            widget.dialog.add_column_button.setVisible(set_visibility)
+            widget.dialog.remove_column_button.setVisible(set_visibility)
+
     def get_attrs(self):
         attrs_list = []
         for index in range(self.list_widget.count()):
@@ -103,6 +133,8 @@ def _setup_attribute_name_validator(self, frame):
             )
         )
 
+    update_attributes_signal = Signal(tuple)
+
 
 class FieldAttrFrame(QFrame):
     def __init__(self, attr=None, parent=None):
@@ -187,13 +219,12 @@ def name(self, new_name: str):
 
     @property
     def value(self) -> Union[np.generic, np.ndarray]:
-
         if self.is_scalar:
-            if self.dtype == VALUE_TYPE_TO_NP[ValueTypes.STRING] or isinstance(
-                self.dtype, str
-            ):
+            if self.dtype == ValueTypes.STRING:
                 return self.attr_value_lineedit.text()
-            return self.dtype(VALUE_TYPE_TO_NP[self.attr_value_lineedit.text()])
+            value = self.attr_value_lineedit.text()
+            type_cast = VALUE_TYPE_TO_NP[self.attr_dtype_combo.currentText()]
+            return type_cast(value) if value else ""
         return np.squeeze(self.dialog.model.array)
 
     @value.setter
@@ -209,5 +240,8 @@ def value(self, new_value: np.ndarray):
         else:
             self.type_changed(ARRAY)
             self.dialog.model.array = new_value
-            self.dialog.model.update_array_dtype(new_value.dtype)
+            try:
+                self.dialog.model.update_array_dtype(new_value.dtype)
+            except AttributeError:
+                pass
         self.dtype_changed(None)

nexus_constructor/json/load_from_json.py

@@ -199,6 +199,7 @@ def load_model_from_json(self, filename: str) -> bool:
 
     def _load_from_json_dict(self, json_dict: Dict) -> bool:
         self.entry_node = self._read_json_object(json_dict[CommonKeys.CHILDREN][0])
+        self.model.entry.attributes = self.entry_node.attributes
         for child in self.entry_node.children:
             if isinstance(child, (Dataset, Link, Group)):
                 self.model.entry[child.name] = child
@@ -333,7 +334,6 @@ def _read_json_object(self, json_object: Dict, parent_node: Group = None):
                 self.model.entry[nexus_object.name] = nexus_object
             if isinstance(nexus_object, Group):
                 nexus_object.group_placeholder = use_placeholder
-
         return nexus_object
 
     def _add_object_warning(self, missing_info, parent_node):

nexus_constructor/main_window.py

@@ -1,5 +1,5 @@
 import json
-from typing import Dict, List
+from typing import Dict, List, Union
 from weakref import WeakKeyDictionary
 
 from PySide6.QtCore import Qt
@@ -13,10 +13,16 @@
 from ui.main_window import Ui_MainWindow
 
 from .about_window import AboutWindow
+from .common_attrs import CommonAttrs
+from .field_attrs import FieldAttrsDialog
+from .model.attributes import Attributes
+from .model.module import FileWriterModule
+from .model.transformation import Transformation
 
 NEXUS_FILE_TYPES = {"NeXus Files": ["nxs", "nex", "nx5"]}
 JSON_FILE_TYPES = {"JSON Files": ["json", "JSON"]}
 FLATBUFFER_FILE_TYPES = {"FlatBuffer Files": ["flat", "FLAT"]}
+ATTRIBUTES_SKIPPED_LIST = [CommonAttrs.DEPENDS_ON]
 
 
 class MainWindow(Ui_MainWindow, QMainWindow):
@@ -119,6 +125,17 @@ def show_edit_component_dialog(self):
         except IndexError:
             print("Select a valid group in the NeXus tree view before editing.")
 
+    def show_attributes_list_window(self):
+        try:
+            selected_component = (
+                self.component_tree_view_tab.component_tree_view.selectedIndexes()[
+                    0
+                ].internalPointer()
+            )
+            self._show_attributes_list_window(selected_component)
+        except IndexError:
+            print("Select a valid group or module.")
+
     def create_new_json_template(self):
         msg = QMessageBox.question(
             None,
@@ -211,6 +228,36 @@ def show_add_component_window(self, group: Group, new_group: bool):
         )
         self.add_component_window.show()
 
+    def _show_attributes_list_window(
+        self, selected_object: Union[Group, FileWriterModule]
+    ):
+        field_attrs_dialog = FieldAttrsDialog(self)
+        field_attrs_dialog.fill_existing_attrs(selected_object, ATTRIBUTES_SKIPPED_LIST)
+        if isinstance(selected_object, Transformation):
+            field_attrs_dialog.setWindowTitle("Attribute Viewer")
+            field_attrs_dialog.add_button.setVisible(False)
+            field_attrs_dialog.remove_button.setVisible(False)
+            field_attrs_dialog.set_view_only("View Array", False)
+        else:
+            field_attrs_dialog.add_update_signal()
+            field_attrs_dialog.update_attributes_signal.connect(self._update_attributes)
+        field_attrs_dialog.show()
+
+    def _update_attributes(self, edited_attributes: tuple):
+        selected_object = (
+            self.component_tree_view_tab.component_tree_view.selectedIndexes()[
+                0
+            ].internalPointer()
+        )
+        new_attributes = Attributes()
+        for attribute in ATTRIBUTES_SKIPPED_LIST:
+            attribute_val = selected_object.attributes.get_attribute(attribute)
+            if attribute_val:
+                new_attributes.set_attribute_value(attribute, attribute_val)
+        for name, value, attribute_type in edited_attributes:
+            new_attributes.set_attribute_value(name, value, attribute_type)
+        selected_object.attributes = new_attributes
+
     def _update_model(self, selected_group: Group):
         self.component_tree_view_tab.set_up_model(self.model)
         component_model = self.component_tree_view_tab.component_model

nexus_constructor/model/attributes.py

@@ -34,6 +34,11 @@ def get_attribute_value(self, attribute_name: str):
             return _get_item(self, attribute_name).values
         return None
 
+    def get_attribute(self, attribute_name: str):
+        if self.contains_attribute(attribute_name):
+            return _get_item(self, attribute_name)
+        return None
+
     def contains_attribute(self, attribute_name):
         result = _get_item(self, attribute_name)
         return True if result is not None else False

nexus_constructor/module_view.py

@@ -66,6 +66,7 @@ def __init__(self, module, parent: QWidget, model: Model):
         self.model = model
         self._set_existing_items()
         layout.addWidget(self.field_widget)
+        self.field_widget.attrs_button.setVisible(False)
         self.setLayout(layout)
 
     def _set_existing_items(self):

nexus_constructor/treeview_utils.py

@@ -88,6 +88,7 @@ def set_button_states(
     new_translation_action: QAction,
     create_link_action: QAction,
     zoom_action: QAction,
+    show_attrs_action: QAction,
     edit_component_action: QAction,
 ):
     """
@@ -98,6 +99,7 @@ def set_button_states(
     :param new_translation_action: The action for creating a new translation.
     :param create_link_action: The action for creating a link.
     :param zoom_action: The action for zooming on a component.
+    :param show_attrs_action: The action for showing the attributes list.
     :param edit_component_action: The action for editing a component.
     """
     selection_indices = component_tree_view.selectedIndexes()
@@ -109,6 +111,7 @@ def set_button_states(
             new_rotation_action,
             new_translation_action,
             zoom_action,
+            show_attrs_action,
             edit_component_action,
         )
     else:
@@ -118,6 +121,10 @@ def set_button_states(
         allowed_transformation_action = is_transformation_action_allowed(
             selected_object
         )
+        has_attributes = (
+            True if not isinstance(selected_object, LinkTransformation) else False
+        )
+        set_enabled_and_raise(show_attrs_action, has_attributes)
         set_enabled_and_raise(zoom_action, selected_object_is_component)
         is_transform_group = False
         if selected_object_is_group:

nx-class-documentation/html/index.html

@@ -113,7 +113,7 @@ <h1>User Manual and Reference Documentation<a class="headerlink" href="#user-man
 </div>
 <hr class="docutils" />
 <p class="rubric">Publishing Information</p>
-<p>This manual built Oct 17, 2022.</p>
+<p>This manual built Oct 18, 2022.</p>
 <div class="admonition seealso">
 <p class="admonition-title">See also</p>
 <p>This document is available in these formats online:</p>

nx-class-documentation/html/searchindex.js

@@ -3,7 +3,7 @@ numpy
 numpy-stl
 open3d
 pint
-PySide6
+PySide6<6.4.0
 pytest-qt
 xmltodict
 ess-streaming-data-types >= 0.9.5

requirements.txt

@@ -56,6 +56,7 @@ def __init__(self, scene_widget: InstrumentView, parent=None):
         self.component_tree_view.setSelectionMode(QAbstractItemView.SingleSelection)
 
         self.component_tool_bar = QToolBar("Actions", self)
+        self.component_tool_bar.setMinimumWidth(480)
         self.new_component_action = create_and_add_toolbar_action(
             "new_component.png",
             "Group",
@@ -92,6 +93,16 @@ def __init__(self, scene_widget: InstrumentView, parent=None):
             self.component_tool_bar,
             self,
         )
+
+        self.show_attrs_action = create_and_add_toolbar_action(
+            "attributes.png",
+            "Attributes",
+            self.parent().show_attributes_list_window,
+            self.component_tool_bar,
+            self,
+        )
+        self.component_tool_bar.insertSeparator(self.show_attrs_action)
+
         self.zoom_action = create_and_add_toolbar_action(
             "zoom.svg",
             "Zoom",
@@ -138,6 +149,7 @@ def _set_button_state(self):
             self.new_translation_action,
             self.create_link_action,
             self.zoom_action,
+            self.show_attrs_action,
             self.edit_component_action,
         )