wip: translate indicator description

Author: matthiasschaub

ohsome_quality_api/indicators/models.py

@@ -1,7 +1,8 @@
 from datetime import datetime, timezone
 from typing import Literal
 
-from pydantic import BaseModel, ConfigDict, Field, computed_field
+from fastapi_i18n import _
+from pydantic import BaseModel, ConfigDict, Field, computed_field, field_validator
 
 from ohsome_quality_api.projects.definitions import ProjectEnum
 from ohsome_quality_api.quality_dimensions.definitions import QualityDimensionEnum
@@ -18,11 +19,16 @@ class IndicatorMetadata(BaseModel):
     model_config = ConfigDict(
         alias_generator=snake_to_lower_camel,
         title="Metadata",
-        frozen=True,
+        # frozen=True,  # TODO: re-enable
         extra="forbid",
         populate_by_name=True,
     )
 
+    @field_validator("name", "description", mode="before")
+    @classmethod
+    def translate(cls, value: str) -> str:
+        return _(value)
+
 
 class IndicatorTemplates(BaseModel):
     """Result text templates of an indicator as defined in the templates.yaml file."""

ohsome_quality_api/locale/de/LC_MESSAGES/messages.po

@@ -287,7 +287,7 @@ msgstr ""
 msgid ""
 "Calculate if mapping has saturated. High saturation has been reached if "
 "the growth of the fitted curve is minimal."
-msgstr ""
+msgstr "Berechne ob das Kartieren gesättigt ist. Bei hohe Sättigung ist die Steigung der Kurve minimal."
 
 #: ohsome_quality_api/indicators/indicators.yaml
 msgid "Density"

tests/integrationtests/api/test_i18n.py

@@ -0,0 +1,32 @@
+from approvaltests import verify
+
+from tests.integrationtests.utils import oqapi_vcr
+
+ENDPOINT = "/indicators/"
+
+# TODO
+# Test fallback to en if no translation string found -> Use non existent language.
+# Test if no accept-language header is setenv.
+# Test result description
+# Test result figure
+# Remove and recreate VCR cassette for this test
+
+
+@oqapi_vcr.use_cassette
+def test_indicators(client, bpolys, monkeypatch):
+    monkeypatch.setenv(
+        "FASTAPI_I18N_LOCALE_DIR",
+        "/home/matthias/work/projects/oqapi/ohsome_quality_api/locale",
+    )
+    endpoint = "/indicators/mapping-saturation"
+    parameters = {
+        "bpolys": bpolys,
+        "topic": "building-count",
+    }
+    response = client.post(
+        endpoint,
+        json=parameters,
+        headers={"Accept-Language": "de", "accept": "application/json"},
+    )
+    result = response.json()
+    verify(result["result"][0]["metadata"]["description"])

tests/integrationtests/api/test_i18n.test_indicators.approved.txt

@@ -0,0 +1 @@
+Berechne ob das Kartieren gesättigt ist. Bei hohe Sättigung ist die Steigung der Kurve minimal.