draft group regulation config classes (WIP)

Author: nmaarnio

arho_feature_template/core/group_regulation_config.py

@@ -0,0 +1,89 @@
+from __future__ import annotations
+
+import logging
+from dataclasses import dataclass
+from typing import TYPE_CHECKING
+
+import yaml
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+logger = logging.getLogger(__name__)
+
+
+class ConfigSyntaxError(Exception):
+    def __init__(self, message: str):
+        super().__init__(f"Invalid config syntax: {message}")
+
+
+@dataclass
+class PlanRegulationGroupLibraryConfig:
+    """Describes the configuration of a plan regulation group library"""
+
+    name: str
+    version: str
+    plan_regulation_groups: list[PlanRegulationGroupConfig]
+
+    @classmethod
+    def from_dict(cls, data: dict) -> PlanRegulationGroupLibraryConfig:
+        try:
+            return cls(
+                name=data["name"],
+                version=data["version"],
+                plan_regulation_groups=[
+                    PlanRegulationGroupConfig.from_dict(group) for group in data["plan_regulation_groups"]
+                ],
+            )
+        except KeyError as e:
+            raise ConfigSyntaxError(str(e)) from e
+
+
+@dataclass
+class PlanRegulationGroupConfig:
+    """Describes a plan regulation group"""
+
+    name: str
+    category: str
+    geometry: str
+    color_code: str | None
+    letter_code: str | None
+    plan_regulations: list[PlanRegulationConfig]
+
+    @classmethod
+    def from_dict(cls, data: dict) -> PlanRegulationGroupConfig:
+        return cls(
+            name=data["name"],
+            category=data["category"],
+            geometry=data["geometry"],
+            color_code=data.get("color_code"),
+            letter_code=data.get("letter_code"),
+            plan_regulations=[PlanRegulationConfig.from_dict(regulation) for regulation in data["plan_regulations"]],
+        )
+
+
+@dataclass
+class PlanRegulationConfig:
+    """Describes a plan regulation"""
+
+    name: str
+    code: str
+    value: str | None
+    unit: str | None
+    additional_information: dict | None
+
+    @classmethod
+    def from_dict(cls, data: dict) -> PlanRegulationConfig:
+        return cls(
+            name=data["name"],
+            code=data["code"],
+            value=data.get("value"),
+            unit=data.get("unit"),
+            additional_information=data.get("additional_information"),
+        )
+
+
+def parse_group_regulation_library_config(fp: Path) -> PlanRegulationGroupLibraryConfig:
+    with fp.open(encoding="utf-8") as f:
+        data = yaml.safe_load(f)
+        return PlanRegulationGroupLibraryConfig.from_dict(data)