No more locations.locale in config

libbot/i18n/sync/__init__.py

@@ -1,18 +1,24 @@
 from os import listdir
 from pathlib import Path
-from typing import Any, Dict
+from typing import Any, Dict, Union
 
 from libbot import sync
 from libbot.sync import config_get, json_read
 
 
-def _(key: str, *args: str, locale: str = sync.config_get("locale")) -> Any:
+def _(
+    key: str,
+    *args: str,
+    locale: str = sync.config_get("locale"),
+    locales_root: Union[str, Path] = Path("locale"),
+) -> Any:
     """Get value of locale string
 
     ### Args:
-        * key (`str`): The last key of the locale's keys path
-        * *args (`list`): Path to key like: `dict[args][key]`
-        * locale (`str`): Locale to looked up in. Defaults to config's `"locale"` value
+        * key (`str`): The last key of the locale's keys path.
+        * *args (`list`): Path to key like: `dict[args][key]`.
+        * locale (`str`): Locale to looked up in. Defaults to config's `"locale"` value.
+        * locales_root (`Union[str, Path]`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
 
     ### Returns:
         * `Any`: Value of provided locale key. Is usually `str`, `dict` or `list`
@@ -21,14 +27,10 @@ def _(key: str, *args: str, locale: str = sync.config_get("locale")) -> Any:
         locale = sync.config_get("locale")
 
     try:
-        this_dict = json_read(
-            Path(f'{config_get("locale", "locations")}/{locale}.json')
-        )
+        this_dict = json_read(Path(f"{locales_root}/{locale}.json"))
     except FileNotFoundError:
         try:
-            this_dict = json_read(
-                Path(f'{config_get("locale", "locations")}/{config_get("locale")}.json')
-            )
+            this_dict = json_read(Path(f'{locales_root}/{config_get("locale")}.json'))
         except FileNotFoundError:
             return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
 
@@ -42,26 +44,27 @@ def _(key: str, *args: str, locale: str = sync.config_get("locale")) -> Any:
         return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
 
 
-def in_all_locales(key: str, *args: str) -> list:
+def in_all_locales(
+    key: str, *args: str, locales_root: Union[str, Path] = Path("locale")
+) -> list:
     """Get value of the provided key and path in all available locales
 
     ### Args:
         * key (`str`): The last key of the locale's keys path.
         * *args (`list`): Path to key like: `dict[args][key]`.
+        * locales_root (`Union[str, Path]`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
 
     ### Returns:
         * `list`: List of values in all locales
     """
 
     output = []
-    files_locales = listdir(config_get("locale", "locations"))
+    files_locales = listdir(locales_root)
 
     valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
     for lc in valid_locales:
         try:
-            this_dict = json_read(
-                Path(f'{config_get("locale", "locations")}/{lc}.json')
-            )
+            this_dict = json_read(Path(f"{locales_root}/{lc}.json"))
         except FileNotFoundError:
             continue
 
@@ -77,26 +80,27 @@ def in_all_locales(key: str, *args: str) -> list:
     return output
 
 
-def in_every_locale(key: str, *args: str) -> Dict[str, Any]:
+def in_every_locale(
+    key: str, *args: str, locales_root: Union[str, Path] = Path("locale")
+) -> Dict[str, Any]:
     """Get value of the provided key and path in every available locale with locale tag
 
     ### Args:
         * key (`str`): The last key of the locale's keys path.
         * *args (`list`): Path to key like: `dict[args][key]`.
+        * locales_root (`Union[str, Path]`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
 
     ### Returns:
         * `Dict[str, Any]`: Locale is a key and it's value from locale file is a value
     """
 
     output = {}
-    files_locales = listdir(config_get("locale", "locations"))
+    files_locales = listdir(locales_root)
 
     valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
     for lc in valid_locales:
         try:
-            this_dict = json_read(
-                Path(f'{config_get("locale", "locations")}/{lc}.json')
-            )
+            this_dict = json_read(Path(f"{locales_root}/{lc}.json"))
         except FileNotFoundError:
             continue