add partial locale code

Author: antheas

.github/workflows/package-publish.yml

@@ -22,7 +22,11 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install build
+          pip install build babel
+      - name: Generate mo files
+        run: pybabel compile -D hhd -d ./i18n
+      - name: Copy mo files
+        run: cp -R ./i18n/* ./src/hhd/i18n
       - name: Build package
         run: python -m build -s
       - name: Publish package

.gitignore

@@ -3,4 +3,5 @@ venv
 *.egg-info
 dist
 .vscode
-notebooks
+notebooks
+*.mo

MANIFEST.in

@@ -1,5 +1,6 @@
 recursive-include src/hhd *.yml
 recursive-include src/hhd *.yaml
+recursive-include src/hhd *.mo
 graft usr/
 graft src/hhd/http/static
 include src/hhd/http/index.html

pyproject.toml

@@ -42,6 +42,7 @@ overlay = "hhd.plugins.overlay:autodetect"
 # display = "hhd.plugins.display:autodetect"
 
 [project.entry-points."hhd.i18n"]
+hhd = "hhd.i18n:locales"
 
 [project.entry-points."babel.extractors"]
 hhd_yaml = "hhd.contrib.i18n:extract_hhd_yaml"

src/hhd/__main__.py

@@ -223,6 +223,22 @@ def main():
             logger.error(f"No plugins started, exiting...")
             return
 
+        # Load locales
+        locales = []
+        for register in pkg_resources.iter_entry_points("hhd.i18n"):
+            locales.extend(register.resolve()())
+        locales.sort(key=lambda x: x["priority"])
+
+        if locales:
+            lstr = "Loaded the following locales:\n"
+            for locale in locales:
+                lstr += (
+                    f" - {locale['domain']} ({locale['priority']}): {locale['path']}\n"
+                )
+            logger.info(lstr[:-1])
+        else:
+            logger.info("No locales found.")
+
         # Open plugins
         lock = RLock()
         cond = Condition(lock)

src/hhd/i18n/__init__.py

@@ -0,0 +1,9 @@
+from hhd.plugins import HHDLocale, get_relative_fn
+
+
+def _(arg: str):
+    return arg
+
+
+def locales() -> list[HHDLocale]:
+    return [{"path": get_relative_fn("./"), "domain": "hhd", "priority": 10}]

src/hhd/plugins/__init__.py

@@ -1,5 +1,13 @@
 from .conf import Config
-from .plugin import HHDAutodetect, HHDPlugin, Context, Emitter, Event
+from .plugin import (
+    HHDAutodetect,
+    HHDPlugin,
+    Context,
+    Emitter,
+    Event,
+    HHDLocale,
+    HHDLocaleRegister,
+)
 from .settings import HHDSettings
 from .utils import get_relative_fn, load_relative_yaml
 from .outputs import get_outputs_config, get_outputs
@@ -22,4 +30,6 @@
     "get_gyro_config",
     "get_gyro_state",
     "gen_gyro_state",
+    "HHDLocale",
+    "HHDLocaleRegister",
 ]

src/hhd/plugins/plugin.py

@@ -109,6 +109,17 @@ def __call__(self, existing: Sequence[HHDPlugin]) -> Sequence[HHDPlugin]:
         raise NotImplementedError()
 
 
+class HHDLocale(TypedDict):
+    path: str
+    domain: str
+    priority: int
+
+
+class HHDLocaleRegister(Protocol):
+    def __call__(self) -> Sequence[HHDLocale]:
+        raise NotImplementedError()
+
+
 def get_context(user: str | None) -> Context | None:
     try:
         uid = os.getuid()

src/hhd/settings.yml

@@ -4,6 +4,16 @@ settings:
   tags: [non-essential]
 
   children:
+    # language:
+    #   type: multiple
+    #   tags: [i18n, advanced]
+    #   title: Language
+    #   default: system
+    #   options:
+    #     system: English
+    #     zh: Chinese
+    #     pt: Portugese
+
     theme:
       type: multiple
       tags: [theme-selector, advanced]