Implement configuration classes

Author: LKajan

.pre-commit-config.yaml

@@ -12,6 +12,7 @@ repos:
     rev: v1.11.2
     hooks:
       - id: mypy
+        additional_dependencies: ["types-PyYAML"]
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.6.5
     hooks:

arho_feature_template/core/feature_template.py

@@ -0,0 +1,117 @@
+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__)
+
+SUPPORTED_TEMPLATE_VERSION = 1
+
+
+class TemplateLibraryVersionError(Exception):
+    def __init__(self, version: str):
+        super().__init__(f"Template library version {version} is not supported")
+
+
+class TemplateSyntaxError(Exception):
+    def __init__(self, message: str):
+        super().__init__(f"Invalid template syntax: {message}")
+
+
+@dataclass
+class TemplateLibraryConfig:
+    """Describes the configuration of a template library"""
+
+    version: str
+    meta: TemplateLibraryMeta
+    templates: list[FeatureTemplate]
+
+    @classmethod
+    def from_dict(cls, data: dict) -> TemplateLibraryConfig:
+        file_version = data["version"]
+        if file_version != SUPPORTED_TEMPLATE_VERSION:
+            raise TemplateLibraryVersionError(file_version)
+
+        try:
+            return cls(
+                version=file_version,
+                meta=TemplateLibraryMeta.from_dict(data["meta"]),
+                templates=[FeatureTemplate.from_dict(template) for template in data["templates"]],
+            )
+        except KeyError as e:
+            raise TemplateSyntaxError(str(e)) from e
+
+
+@dataclass
+class TemplateLibraryMeta:
+    """Describes the metadata of a template library"""
+
+    name: str
+    description: str | None
+    version: str | None
+
+    @classmethod
+    def from_dict(cls, data: dict) -> TemplateLibraryMeta:
+        return cls(
+            name=data["name"],
+            description=data.get("description"),
+            version=data.get("version"),
+        )
+
+
+@dataclass
+class FeatureTemplate:
+    """Describes a feature template that can include nested features"""
+
+    name: str
+    description: str | None
+    feature: Feature
+
+    @classmethod
+    def from_dict(cls, data: dict) -> FeatureTemplate:
+        return cls(
+            name=data["name"],
+            description=data.get("description"),
+            feature=Feature.from_dict(data["feature"]),
+        )
+
+
+@dataclass
+class Feature:
+    """Describes a feature to be inserted into a Vector layer"""
+
+    layer: str
+    attributes: list[Attribute]
+    child_features: list[Feature] | None
+
+    @classmethod
+    def from_dict(cls, data: dict) -> Feature:
+        return cls(
+            layer=data["layer"],
+            attributes=[Attribute.from_dict(attribute) for attribute in data["attributes"]],
+            child_features=[Feature.from_dict(feature) for feature in data.get("child_features", [])],
+        )
+
+
+@dataclass
+class Attribute:
+    """Describes an attribute to be set on a feature"""
+
+    attribute: str
+    default: str | None
+
+    @classmethod
+    def from_dict(cls, data: dict) -> Attribute:
+        return cls(attribute=data["attribute"], default=data.get("default"))
+
+
+def parse_template_library_config(template_library_config: Path) -> TemplateLibraryConfig:
+    with template_library_config.open(encoding="utf-8") as f:
+        data = yaml.safe_load(f)
+        return TemplateLibraryConfig.from_dict(data)

arho_feature_template/core/template_library_config.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from importlib import resources
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+    from pathlib import Path
+
+
+def library_config_files() -> Iterator[Path]:
+    """Get all template library configuration files."""
+
+    for resource in resources.files(__package__).iterdir():
+        with resources.as_file(resource) as resource_path:
+            if resource_path.suffix == ".yaml":
+                yield resource_path

arho_feature_template/resources/template_libraries/__init__.py

@@ -1,6 +1,6 @@
 version: 1
 meta:
-  name: Asemakaava-kaavamääräyskirjasto
+  name: Asemakaavan kaavamääräykset
   version: "1.0"
 templates:
   - name: Simppeli kaavakohde

arho_feature_template/resources/template_libraries/asemakaava-sample.yaml

@@ -6,13 +6,14 @@ debugpy
 
 # Linting and formatting
 pre-commit
-mypy
 ruff
 flake8
 flake8-qgis
 
-# Stubs
+# Types
+mypy
 PyQt5-stubs
+types-PyYAML
 
 # repo itself
 -e file:.

requirements-dev.in

@@ -46,6 +46,8 @@ tomli==2.0.1 ; python_full_version < '3.11'
     # via
     #   -c requirements-test.txt
     #   mypy
+types-pyyaml==6.0.12.20240917
+    # via -r requirements-dev.in
 typing-extensions==4.12.2
     # via mypy
 virtualenv==20.26.5