Single file languages list

docs/user-guide/translation.rst

@@ -26,8 +26,7 @@ Adding a new language
 ---------------------
 If you want to support a new language:
 
-- add it in ``./scripts/update_translation_files`` in the language list,
-- add it in ``scan/libmailgoose/language.py`` in the ``Language`` enum,
+- add it in ``scan/libmailgoose/languages.txt``,
 - run ``./scripts/update_translation_files`` and fill ``.po`` files for the UI messages for your language in ``./app/translations``
   (**you may skip that part if you want only the library error messages to be translated**),
 - add the error message translations for your language in ``scan/libmailgoose/translate.py``.

scan/libmailgoose/language.py

@@ -1,7 +1,5 @@
 from enum import Enum
+from pathlib import Path
 
-
-class Language(Enum):
-    en_US = "en_US"
-    lt_LT = "lt_LT"
-    pl_PL = "pl_PL"
+with open(Path(__file__).parent / "languages.txt") as f:
+    Language = Enum("Language", {line.strip(): line.strip() for line in f})  # type: ignore

scan/libmailgoose/languages.txt

@@ -0,0 +1,3 @@
+pl_PL
+en_US
+lt_LT

scan/libmailgoose/translate.py

@@ -10,7 +10,7 @@
 
 
 TRANSLATIONS = {
-    Language.lt_LT: [
+    Language.lt_LT: [  # type: ignore
         (
             "SPF '~all' or '-all' directive not found. We recommend adding it, as it describes "
             "what should happen with messages that fail SPF verification. For example, "
@@ -435,7 +435,7 @@
             "DKIM parašo patvirtinimo metu įvyko nežinoma klaida.",
         ),
     ],
-    Language.pl_PL: [
+    Language.pl_PL: [  # type: ignore
         (
             "SPF '~all' or '-all' directive not found. We recommend adding it, as it describes "
             "what should happen with messages that fail SPF verification. For example, "
@@ -985,7 +985,7 @@ def translate(
     language: Language,
     nonexistent_translation_handler: Optional[Callable[[str], str]] = None,
 ) -> str:
-    if language == Language.en_US:
+    if language == Language.en_US:  # type: ignore
         return message
 
     return _translate_using_dictionary(

scan/setup.py

@@ -16,6 +16,8 @@
     license="BSD",
     url="https://github.com/CERT-Polska/mailgoose",
     packages=["libmailgoose"],
+    package_data={"": ["languages.txt"]},
+    include_package_data=True,
     scripts=[],
     classifiers=[
         "Programming Language :: Python :: 3",

scripts/update_translation_files

@@ -1,9 +1,9 @@
 #!/bin/bash
 
-LOCALES="pl_PL en_US lt_LT"
-
 cd $(dirname $0)/..
 
+LOCALES=`cat scan/libmailgoose/languages.txt`
+
 if [ ! -d .venv.translations ]
 then
     python3 -m venv .venv.translations