fixed issues with the update-language nox session

Author: flpm

_ext/translation_graph.py

@@ -1,13 +1,14 @@
-from pathlib import Path
 import json
-from typing import TYPE_CHECKING, TypeAlias, TypedDict, Annotated as A
+from pathlib import Path
+from typing import TYPE_CHECKING, TypeAlias, TypedDict
+from typing import Annotated as A
 
+import numpy as np
+import plotly.graph_objects as go
 from babel.messages import pofile
 from docutils import nodes
 from docutils.parsers.rst import Directive
-import plotly.graph_objects as go
 from plotly.offline import plot
-import numpy as np
 
 if TYPE_CHECKING:
     from sphinx.application import Sphinx
@@ -17,14 +18,18 @@
 LOCALES_DIR = BASE_DIR / "locales"  # Locales directory
 STATIC_DIR = BASE_DIR / "_static"  # Static directory
 
+
 class ModuleStats(TypedDict):
     total: int
     translated: int
     fuzzy: int
     untranslated: int
     percentage: float
 
-TranslationStats: TypeAlias = dict[A[str, "locale"], dict[A[str, "module"], ModuleStats]]
+
+TranslationStats: TypeAlias = dict[
+    A[str, "locale"], dict[A[str, "module"], ModuleStats]
+]
 
 
 class TranslationGraph(Directive):
@@ -42,19 +47,39 @@ class TranslationGraph(Directive):
     Total: %{customdata.total}<br>
     Completed: %{customdata.percentage}%
     """
+
     def run(self):
         data = get_translation_stats()
 
         # Sort data by locale and module
-        data = {locale: dict(sorted(loc_stats.items())) for locale, loc_stats in sorted(data.items())}
+        data = {
+            locale: dict(sorted(loc_stats.items()))
+            for locale, loc_stats in sorted(data.items())
+        }
 
         # prepend english, everything set to 100%
-        en = {module: ModuleStats(total=stats['total'], translated=stats['total'], fuzzy=stats['total'], untranslated=0, percentage=100) for module, stats in next(iter(data.values())).items()}
-        data = {'en': en} | data
+        en = {
+            module: ModuleStats(
+                total=stats["total"],
+                translated=stats["total"],
+                fuzzy=stats["total"],
+                untranslated=0,
+                percentage=100,
+            )
+            for module, stats in next(iter(data.values())).items()
+        }
+        data = {"en": en} | data
 
         # Calculate average completion percentage for each locale and sort locales
-        locale_completion = {locale: np.mean([stats['percentage'] for stats in loc_stats.values()]) for locale, loc_stats in data.items()}
-        sorted_locales = sorted(locale_completion.keys(), key=lambda locale: locale_completion[locale], reverse=True)
+        locale_completion = {
+            locale: np.mean([stats["percentage"] for stats in loc_stats.values()])
+            for locale, loc_stats in data.items()
+        }
+        sorted_locales = sorted(
+            locale_completion.keys(),
+            key=lambda locale: locale_completion[locale],
+            reverse=True,
+        )
 
         # Reorder data based on sorted locales
         data = {locale: data[locale] for locale in sorted_locales}
@@ -64,11 +89,20 @@ def run(self):
         modules = list(next(iter(data.values())).keys())
 
         # Extract data to plot
-        values = [[stats['percentage'] for stats in loc_stats.values()] for loc_stats in data.values()]
-        hoverdata = [[{'module': module} | stats for module, stats in loc_stats.items()] for loc_stats in data.values()]
+        values = [
+            [stats["percentage"] for stats in loc_stats.values()]
+            for loc_stats in data.values()
+        ]
+        hoverdata = [
+            [{"module": module} | stats for module, stats in loc_stats.items()]
+            for loc_stats in data.values()
+        ]
 
         # Add text to display percentages directly in the heatmap boxes
-        text = [[f"{int(stats['percentage'])}%" for stats in loc_stats.values()] for loc_stats in data.values()]
+        text = [
+            [f"{int(stats['percentage'])}%" for stats in loc_stats.values()]
+            for loc_stats in data.values()
+        ]
 
         heatmap = go.Heatmap(
             x=modules,
@@ -83,23 +117,28 @@ def run(self):
             hovertemplate=self.HOVER_TEMPLATE,
             name="",  # Set the trace name to an empty string to remove "trace 0" from hoverbox
             colorbar={
-                'orientation': 'h',
-                'y': 0,
+                "orientation": "h",
+                "y": 0,
                 "yanchor": "bottom",
                 "yref": "container",
                 "title": "Completion %",
                 "thickness": 10,
                 "tickvals": [12.5, 50, 87.5, 100],  # Midpoints for each category
-                "ticktext": ["0-25%", "25-75%", "75-<100%", "100%"],  # Labels for categories
+                "ticktext": [
+                    "0-25%",
+                    "25-75%",
+                    "75-<100%",
+                    "100%",
+                ],  # Labels for categories
             },
             colorscale=[
-                [0.0,  "rgb(254, 255, 231)"],   # 0-25%
+                [0.0, "rgb(254, 255, 231)"],  # 0-25%
                 [0.25, "rgb(254, 255, 231)"],
-                [0.25, "rgb(187, 130, 176)"],   # 25-75%
+                [0.25, "rgb(187, 130, 176)"],  # 25-75%
                 [0.75, "rgb(187, 130, 176)"],
-                [0.75, "rgb(129, 192, 170)"],   # 75-<100%
+                [0.75, "rgb(129, 192, 170)"],  # 75-<100%
                 [0.99, "rgb(129, 192, 170)"],
-                [1.0,  "rgb(78,  112, 100)"],   # 100%
+                [1.0, "rgb(78,  112, 100)"],  # 100%
             ],
         )
         # Create figure
@@ -112,7 +151,7 @@ def run(self):
             xaxis_showgrid=False,
             xaxis_side="top",
             xaxis_tickangle=-45,
-            xaxis_tickfont = {
+            xaxis_tickfont={
                 "family": "var(--bs-font-monospace)",
             },
             yaxis_showgrid=False,
@@ -127,7 +166,8 @@ def run(self):
         )
         return [nodes.raw("", div, format="html")]
 
-def calculate_translation_percentage(po_path : Path, locale : str) -> ModuleStats:
+
+def calculate_translation_percentage(po_path: Path, locale: str) -> ModuleStats:
     """
     Calculate the translation percentage for a given .po file.
 
@@ -170,7 +210,7 @@ def calculate_translation_percentage(po_path : Path, locale : str) -> ModuleStat
         "translated": translated,
         "fuzzy": fuzzy,
         "untranslated": total - translated - fuzzy,
-        "percentage": round(percentage, 2)
+        "percentage": round(percentage, 2),
     }
 
 
@@ -218,10 +258,16 @@ def get_translation_stats() -> TranslationStats:
 
     return results
 
+
 def write_translation_stats(app: "Sphinx", exception: Exception | None) -> None:
     from sphinx.util import logging
+
     logger = logging.getLogger("_ext.translation_graph")
 
+    if app.builder.name != "html":
+        logger.info("Skipping translation stats for non-HTML build")
+        return
+
     stats = get_translation_stats()
     out_path = app.outdir / "_static" / "translation_stats.json"
     with open(out_path, "w") as f: