feat: add get_template function

Author: matthiasschaub

ohsome_quality_api/indicators/base.py

@@ -1,13 +1,20 @@
 import json
+import os
 from abc import ABCMeta, abstractmethod
 
 import plotly.graph_objects as go
+import yaml
 from geojson import Feature, Polygon
 
-from ohsome_quality_api.definitions import get_attribution, get_metadata
+from ohsome_quality_api.definitions import get_attribution
 from ohsome_quality_api.indicators.models import IndicatorMetadata, Result
 from ohsome_quality_api.topics.models import BaseTopic as Topic
-from ohsome_quality_api.utils.helper import json_serialize
+from ohsome_quality_api.utils.helper import (
+    camel_to_hyphen,
+    camel_to_snake,
+    get_module_dir,
+    json_serialize,
+)
 
 
 class BaseIndicator(metaclass=ABCMeta):
@@ -18,9 +25,7 @@ def __init__(
         topic: Topic,
         feature: Feature,
     ) -> None:
-        self.metadata: IndicatorMetadata = get_metadata(
-            "indicators", type(self).__name__
-        )
+        self.metadata: IndicatorMetadata = self.get_template()
         self.topic: Topic = topic
         self.feature: Feature = feature
         self.result: Result = Result(
@@ -167,3 +172,15 @@ def _get_default_figure(self) -> None:
         raw = fig.to_dict()
         raw["layout"].pop("template")  # remove boilerplate
         self.result.figure = raw
+
+    def get_template(self) -> dict:
+        """Get template for indicator."""
+        indicator_key = camel_to_snake(type(self).__name__)
+        dir = get_module_dir(f"ohsome_quality_api.indicators.{indicator_key}")
+        file = os.path.join(dir, "metadata.yaml")
+        with open(file, "r") as file:
+            raw = yaml.safe_load(file)
+        metadata = {}
+        for k, v in raw.items():
+            metadata[k] = IndicatorMetadata(**v)
+        return metadata[camel_to_hyphen(type(self).__name__)]

tests/integrationtests/test_base_indicator.py

@@ -5,7 +5,7 @@
 from geojson import Feature
 
 from ohsome_quality_api.indicators.minimal.indicator import Minimal
-from ohsome_quality_api.indicators.models import Result
+from ohsome_quality_api.indicators.models import IndicatorMetadata, Result
 
 from .utils import get_geojson_fixture, get_topic_fixture
 
@@ -81,6 +81,12 @@ def test_figure(self, feature, topic):
         # comment out for manual test
         # pio.show(indicator.result.figure)
 
+    def test_get_template(self, feature, topic):
+        indicator = Minimal(feature=feature, topic=topic)
+        indicator.get_template()
+        assert isinstance(indicator.metadata, IndicatorMetadata)
+        assert isinstance(indicator.result, Result)
+
 
 class TestBaseResult:
     def test_label(self):