add util functions to misc_utils.py, fix additional_information type in PlanRegulationDefinition

Author: nmaarnio

arho_feature_template/core/plan_manager.py

@@ -5,20 +5,12 @@
 from arho_feature_template.core.update_plan import LandUsePlan, update_selected_plan
 from arho_feature_template.gui.load_plan_dialog import LoadPlanDialog
 from arho_feature_template.utils.db_utils import get_existing_database_connection_names
-from arho_feature_template.utils.misc_utils import handle_unsaved_changes
+from arho_feature_template.utils.misc_utils import get_layer_by_name, handle_unsaved_changes
 
 
 class PlanManager:
     def __init__(self):
-        self.kaava_layer = self.get_layer_by_name("Kaava")
-
-    def get_layer_by_name(self, layer_name):
-        """Retrieve a layer by name from the project."""
-        layers = QgsProject.instance().mapLayersByName(layer_name)
-        if layers:
-            return layers[0]
-        iface.messageBar().pushMessage("Error", f"Layer '{layer_name}' not found", level=3)
-        return None
+        self.kaava_layer = get_layer_by_name("Kaava")
 
     def add_new_plan(self):
         """Initiate the process to add a new plan to the Kaava layer."""

arho_feature_template/core/plan_regulation_config.py

@@ -8,16 +8,15 @@
 from typing import TYPE_CHECKING, cast
 
 import yaml
-from qgis.core import QgsProject
 from qgis.utils import iface
 
 from arho_feature_template.qgis_plugin_tools.tools.resources import resources_path
+from arho_feature_template.utils.misc_utils import get_layer_by_name
 
 if TYPE_CHECKING:
     from numbers import Number
     from typing import Literal
 
-    from qgis.core import QgsMapLayer
     from qgis.gui import QgisInterface
 
     iface: QgisInterface = cast("QgisInterface", iface)  # type: ignore[no-redef]
@@ -56,16 +55,6 @@ class Unit(Enum):
     DECIBEL = "dB"
 
 
-# TODO: Same as in PlanManager, should refactor
-def get_layer_by_name(layer_name: str) -> QgsMapLayer | None:
-    """Retrieve a layer by name from the project."""
-    layers = QgsProject.instance().mapLayersByName(layer_name)
-    if layers:
-        return layers[0]
-    iface.messageBar().pushMessage("Error", f"Layer '{layer_name}' not found", level=3)
-    return None
-
-
 def get_name_mapping_for_plan_regulations(layer_name: str) -> dict[str, dict[str, str]] | None:
     layer = get_layer_by_name(layer_name)
     if not layer:
@@ -188,7 +177,9 @@ class PlanRegulationDefinition:
 
     regulation_config: PlanRegulationConfig
     default_value: str | Number | None
-    additional_info: dict[str, str | Number | None]  # NOTE: Correct typing for additional information values?
+    additional_information: list[
+        dict[str, str | Number | None]
+    ]  # NOTE: Correct typing for additional information values?
     regulation_number: int | None
     attached_files: list[Path]
 
@@ -197,7 +188,7 @@ def from_dict(cls, data: dict) -> PlanRegulationDefinition:
         return cls(
             regulation_config=data["config"],
             default_value=data.get("default_value"),
-            additional_info=data.get("additional_info", {}),
+            additional_information=data.get("additional_information", []),
             regulation_number=data.get("regulation_number"),
             attached_files=data.get("attached_files", []),
         )

arho_feature_template/gui/plan_regulation_widget.py

@@ -20,6 +20,7 @@
 )
 
 from arho_feature_template.core.plan_regulation_config import PlanRegulationConfig, Unit, ValueType
+from arho_feature_template.utils.misc_utils import get_additional_information_name
 
 if TYPE_CHECKING:
     from numbers import Number

arho_feature_template/utils/misc_utils.py

@@ -1,12 +1,54 @@
+from __future__ import annotations
+
 import os
+from typing import TYPE_CHECKING, cast
 
 from qgis.core import QgsExpressionContextUtils, QgsProject, QgsVectorLayer
 from qgis.PyQt.QtCore import QSettings
 from qgis.PyQt.QtWidgets import QMessageBox
+from qgis.utils import iface
+
+if TYPE_CHECKING:
+    from typing import Literal
+
+    from qgis.core import QgsMapLayer
+    from qgis.gui import QgisInterface
+
+    iface: QgisInterface = cast("QgisInterface", iface)  # type: ignore[no-redef]
 
 PLUGIN_PATH = os.path.dirname(os.path.dirname(__file__))
 
 
+# NOTE: Consider creating "layer_utils.py" or similar for layer related utils in the future
+def get_layer_by_name(layer_name: str) -> QgsMapLayer | None:
+    """
+    Retrieve a layer by name from the project.
+
+    If multiple layers with the same name exist, returns the first one. Returns None
+    if layer with a matching name is not found.
+    """
+    layers = QgsProject.instance().mapLayersByName(layer_name)
+    if layers:
+        return layers[0]
+    iface.messageBar().pushWarning("Error", f"Layer '{layer_name}' not found")
+    return None
+
+
+def get_additional_information_name(info_type: str, language: Literal["fin", "eng", "swe"] = "fin") -> str:
+    """
+    Retrieve name of input additional information type from associated QGIS layer.
+
+    Returns input `info_type` if name is not found.
+    """
+    type_of_additional_information_layer_name = "Lisätiedonlaji"
+    layer = get_layer_by_name(type_of_additional_information_layer_name)
+    if layer:
+        for feature in layer.getFeatures():
+            if feature["value"] == info_type:
+                return feature["name"][language]
+    return info_type
+
+
 def check_layer_changes() -> bool:
     """Check if there are unsaved changes in any QGIS layers."""
     project = QgsProject.instance()