enh: functionalize resource name reset button (#84)

Author: paulmueller

CHANGELOG

@@ -1,8 +1,10 @@
 0.17.2
  - fix: not all resource name edits were recognized in upload dialog (#84)
  - fix: check for existence of DC resources before starting uploads (#85)
+ - enh: functionalize resource name reset button (#84)
  - enh: sort resources according to internal basin dependencies (#79)
  - enh: warn user about too many resources in a dataset (#86)
+ - reg: do not always add directory name to resource name in upload dialog
  - ref: use more f-strings
  - ref: add `common.is_dc_file` for consistent resource checks
 0.17.1

dcoraid/gui/upload/dlg_upload.py

@@ -115,6 +115,7 @@ def __init__(self, *args, **kwargs):
         # resource-related signals
         self.lineEdit_res_filename.textEdited.connect(
             self.on_update_resources_model)
+        self.toolButton_res_filename.clicked.connect(self.on_reset_filename)
         self.widget_schema.schema_changed.connect(
             self.on_update_resources_model)
         self.selModel.selectionChanged.connect(self.on_selection_changed)
@@ -398,6 +399,14 @@ def on_rem_resources(self):
         self.rvmodel.rem_resources(sel)
         self.listView_resources.clearSelection()
 
+    @QtCore.pyqtSlot()
+    def on_reset_filename(self):
+        """Reset the filename of the current resource"""
+        sel = self.listView_resources.selectedIndexes()
+        self.rvmodel.reset_filenames(sel)
+        # update lineEdit_res_filename
+        self.on_selection_changed()
+
     @QtCore.pyqtSlot()
     def on_selection_changed(self):
         """User changed the ListView selection; Refresh side panel"""

dcoraid/gui/upload/dlg_upload.ui

@@ -296,10 +296,10 @@
              <bool>false</bool>
             </property>
             <property name="selectionMode">
-             <enum>QAbstractItemView::ExtendedSelection</enum>
+             <enum>QAbstractItemView::SelectionMode::ExtendedSelection</enum>
             </property>
             <property name="selectionBehavior">
-             <enum>QAbstractItemView::SelectRows</enum>
+             <enum>QAbstractItemView::SelectionBehavior::SelectRows</enum>
             </property>
            </widget>
           </item>
@@ -377,10 +377,7 @@
                 </widget>
                </item>
                <item>
-                <widget class="QToolButton" name="toolButton">
-                 <property name="enabled">
-                  <bool>false</bool>
-                 </property>
+                <widget class="QToolButton" name="toolButton_res_filename">
                  <property name="acceptDrops">
                   <bool>false</bool>
                  </property>
@@ -531,10 +528,10 @@
                    <string notr="true">color:#888</string>
                   </property>
                   <property name="frameShadow">
-                   <enum>QFrame::Plain</enum>
+                   <enum>QFrame::Shadow::Plain</enum>
                   </property>
                   <property name="orientation">
-                   <enum>Qt::Horizontal</enum>
+                   <enum>Qt::Orientation::Horizontal</enum>
                   </property>
                  </widget>
                 </item>
@@ -550,10 +547,10 @@
                    <bool>false</bool>
                   </property>
                   <property name="frameShape">
-                   <enum>QFrame::NoFrame</enum>
+                   <enum>QFrame::Shape::NoFrame</enum>
                   </property>
                   <property name="frameShadow">
-                   <enum>QFrame::Plain</enum>
+                   <enum>QFrame::Shadow::Plain</enum>
                   </property>
                   <property name="lineWidth">
                    <number>0</number>
@@ -566,8 +563,8 @@
                     <rect>
                      <x>0</x>
                      <y>0</y>
-                     <width>494</width>
-                     <height>575</height>
+                     <width>509</width>
+                     <height>557</height>
                     </rect>
                    </property>
                    <layout class="QVBoxLayout" name="verticalLayout_6">
@@ -616,10 +613,10 @@
       <bool>false</bool>
      </property>
      <property name="orientation">
-      <enum>Qt::Horizontal</enum>
+      <enum>Qt::Orientation::Horizontal</enum>
      </property>
      <property name="standardButtons">
-      <set>QDialogButtonBox::Apply|QDialogButtonBox::Cancel</set>
+      <set>QDialogButtonBox::StandardButton::Apply|QDialogButtonBox::StandardButton::Cancel</set>
      </property>
     </widget>
    </item>

dcoraid/gui/upload/resources_model.py

@@ -1,3 +1,4 @@
+import collections
 import re
 from collections import OrderedDict
 import copy
@@ -29,7 +30,18 @@ def add_resources(self, rslist):
         """
         for ff in rslist:
             if ff not in self.resources:  # avoid adding the same file twice
-                self.resources[ff] = {}
+                # initialize file metadata
+                data = {"file": {}}
+                path = pathlib.Path(ff)
+                fname = path.name
+                if re.match("M[0-9]*_data.rtdc", fname):
+                    # We have M0001_data.rtdc. Get the file name from the
+                    # directory above so the user does not have to manually
+                    # rename everything
+                    fname = f"{path.parent.name}_{fname}"
+                data["file"]["filename"] = job.valid_resource_name(fname)
+                data["file"]["filename_init"] = data["file"]["filename"]
+                self.resources[ff] = data
                 self.layoutChanged.emit()
 
     def data(self, index, role=QtCore.Qt.ItemDataRole.DisplayRole):
@@ -80,7 +92,7 @@ def supplements_were_edited(self):
 
     def get_all_data(self, magic_keys=True):
         """Return dictionary with complete information for all resources"""
-        data = {}
+        data = collections.OrderedDict()
         for ii, path in enumerate(self.resources.keys()):
             data[path] = self.get_data_for_row(ii, magic_keys=magic_keys)[1]
         return data
@@ -111,17 +123,6 @@ def get_data_for_row(self, row, magic_keys=True):
         """Return the complete information dictionary for this row index"""
         rfile = self.get_file_list()[row]
         data = copy.deepcopy(self.resources[rfile])
-        if "file" not in data:
-            data["file"] = {}
-        if "filename" not in data["file"]:
-            path = pathlib.Path(rfile)
-            fname = path.name
-            if re.match("M[0-9]*_data.rtdc", "M0001_data.rtdc"):
-                # We have M0001_data.rtdc. Get the file name from the
-                # directory above so the user does not have to manually
-                # rename everything
-                fname = f"{path.parent.name}_{fname}"
-            data["file"]["filename"] = job.valid_resource_name(fname)
         if "supplement" not in data:
             data["supplement"] = {}
         if not magic_keys:
@@ -169,6 +170,16 @@ def rem_resources(self, indexes):
                 self.resources.pop(pp)
         self.layoutChanged.emit()
 
+    def reset_filenames(self, indexes):
+        """Reset the file names of the resources in list of index instances"""
+        resource_keys = list(self.resources.keys())
+        ids = [idx.row() for idx in indexes]
+        for index in ids:
+            key = resource_keys[index]
+            self.resources[key]["file"]["filename"] = \
+                self.resources[key]["file"]["filename_init"]
+        self.layoutChanged.emit()
+
     def rowCount(self, index=None):
         """Return number of resources"""
         return len(self.resources)
@@ -181,7 +192,7 @@ def update_resources(self, indexes, data_dict):
         elif len(indexes) == 1 and "file" in data_dict:
             # update the name
             pp = self.get_filename_from_index(indexes[0])
-            self.resources[pp].update({"file": data_dict["file"]})
+            self.resources[pp]["file"].update(data_dict["file"])
 
         if "supplement" in data_dict:
             for idx in indexes: