centralize stringifying datetime strings for Diff and Save

Author: KatKatKateryna

pygeoapi_config_dialog.py

@@ -149,14 +149,6 @@ class CustomDumper(yaml.SafeDumper):
             ),
         )
 
-        def represent_datetime_as_timestamp(dumper, data: datetime):
-            value = self.config_data.datetime_to_string(data)
-
-            # emit as YAML timestamp → plain scalar, no quotes
-            return dumper.represent_scalar("tag:yaml.org,2002:timestamp", value)
-
-        self.dumper.add_representer(datetime, represent_datetime_as_timestamp)
-
         # custom assignments
         self.model = QStringListModel()
         self.proxy = QSortFilterProxyModel()
@@ -177,25 +169,31 @@ def on_button_clicked(self, button):
 
                 if self.serverRadio.isChecked():
                     # check #1: show diff with "Procced" and "Cancel" options
-                    if not self._diff_original_and_current_data():
+                    diff_approved, processed_config_data = (
+                        self._diff_original_and_current_data()
+                    )
+                    if not diff_approved:
                         return
 
-                    self.server_config(save=True)
+                    self.server_config(data_to_push=processed_config_data)
                 else:
                     # check #1: show diff with "Procced" and "Cancel" options
-                    if not self._diff_original_and_current_data():
+                    diff_approved, processed_config_data = (
+                        self._diff_original_and_current_data()
+                    )
+                    if not diff_approved:
                         return
 
                     file_path, _ = QFileDialog.getSaveFileName(
                         self, "Save File", "", "YAML Files (*.yml);;All Files (*)"
                     )
                     # check #2: valid file path
                     if file_path:
-                        self.save_to_file(file_path)
+                        self.save_to_file(processed_config_data, file_path)
 
         elif button == self.buttonBox.button(QDialogButtonBox.Open):
             if self.serverRadio.isChecked():
-                self.server_config(save=False)
+                self.server_config(data_to_push=None)
             else:
                 file_name, _ = QFileDialog.getOpenFileName(
                     self, "Open File", "", "YAML Files (*.yml);;All Files (*)"
@@ -206,33 +204,29 @@ def on_button_clicked(self, button):
             self.reject()
             return
 
-    def server_config(self, save):
+    def server_config(self, data_to_push: dict | None = None):
 
         dialog = ServerConfigDialog(self)
 
         if dialog.exec_():
             url = dialog.get_server_url()
-            if save:
-                self.push_to_server(url)
+            if data_to_push is not None:
+                self.push_to_server(url, data_to_push)
             else:
                 self.pull_from_server(url)
 
-    def push_to_server(self, url):
+    def push_to_server(self, url, data_to_push: dict):
 
         QMessageBox.information(
             self,
             "Information",
             f"Pushing configuration to: {url}",
         )
 
-        processed_config_dict = self.config_data.asdict_enum_safe(
-            self.config_data, datetime_to_str=True
-        )
-
         # TODO: support authentication through the QT framework
         try:
             # Send the PUT request to Admin API
-            response = requests.put(url, headers=headers, json=processed_config_dict)
+            response = requests.put(url, headers=headers, json=data_to_push)
             response.raise_for_status()
 
             QgsMessageLog.logMessage(f"Success! Status Code: {response.status_code}")
@@ -248,7 +242,7 @@ def push_to_server(self, url):
             QMessageBox.critical(
                 self,
                 "Error",
-                f"An error occurred pulling the configuration from the server: {e}",
+                f"An error occurred pushing the configuration to the server: {e}",
             )
 
     def pull_from_server(self, url):
@@ -287,14 +281,14 @@ def pull_from_server(self, url):
                 f"An error occurred pulling the configuration from the server: {e}",
             )
 
-    def save_to_file(self, file_path):
+    def save_to_file(self, new_config_data: dict, file_path: str):
 
         if file_path:
             QApplication.setOverrideCursor(Qt.WaitCursor)
             try:
                 with open(file_path, "w", encoding="utf-8") as file:
                     yaml.dump(
-                        self.config_data.asdict_enum_safe(self.config_data),
+                        new_config_data,
                         file,
                         Dumper=self.dumper,
                         default_flow_style=False,
@@ -402,14 +396,20 @@ def _set_validate_ui_data(self) -> tuple[bool, list]:
             QMessageBox.warning(f"Error deserializing: {e}")
             return
 
-    def _diff_original_and_current_data(self) -> tuple[bool, list]:
+    def _diff_original_and_current_data(self) -> tuple[bool, dict]:
         """Before saving the file, show the diff and give an option to proceed or cancel."""
+
+        new_config_data = self.config_data.asdict_enum_safe(
+            self.config_data, datetime_to_str=True
+        )
+
+        # if created from skratch, no original data to compare to
         if not self.yaml_original_data:
-            return True
+            return True, new_config_data
 
         diff_data = diff_yaml_dict(
             self.yaml_original_data,
-            self.config_data.asdict_enum_safe(self.config_data),
+            new_config_data,
         )
 
         if (
@@ -418,17 +418,17 @@ def _diff_original_and_current_data(self) -> tuple[bool, list]:
             + len(diff_data["changed"])
             == 0
         ):
-            return True
+            return True, new_config_data
 
         # add a window with the choice
         QgsMessageLog.logMessage(f"{diff_data}")
         dialog = ReadOnlyTextDialog(self, "Warning", diff_data, True)
         result = dialog.exec_()  # returns QDialog.Accepted (1) or QDialog.Rejected (0)
 
         if result == QDialog.Accepted:
-            return True
+            return True, new_config_data
         else:
-            return False
+            return False, None
 
     def open_templates_path_dialog(self):
         """Defining Server.templates.path path, called from .ui file."""

tests/test_yaml_save.py

@@ -41,8 +41,11 @@ def test_json_schema_on_open_save(qtbot, sample_yaml: str):
     dialog.open_file(sample_yaml)  # now dialog.config_data has the data stored
 
     # Save YAML
+    processed_config_data = dialog.config_data.asdict_enum_safe(
+        dialog.config_data, datetime_to_str=True
+    )
     abs_new_yaml_path = sample_yaml.with_name(f"saved_{sample_yaml.name}")
-    dialog.save_to_file(abs_new_yaml_path)
+    dialog.save_to_file(processed_config_data, abs_new_yaml_path)
 
     result = subprocess.run(
         [
@@ -103,8 +106,11 @@ def test_open_file_validate_ui_data_save_file(qtbot, sample_yaml: str):
     yaml1_missing_props = deepcopy(dialog.config_data.all_missing_props)
 
     # Save YAML - EVEN THOUGH some mandatory fields might be missing and recorded as empty strings/lists
+    processed_config_data = dialog.config_data.asdict_enum_safe(
+        dialog.config_data, datetime_to_str=True
+    )
     abs_new_yaml_path = sample_yaml.with_name(f"saved_updated_{sample_yaml.name}")
-    dialog.save_to_file(abs_new_yaml_path)
+    dialog.save_to_file(processed_config_data, abs_new_yaml_path)
 
     # open the new file
     dialog.open_file(abs_new_yaml_path)  # now dialog.config_data has the data stored