Added nested_set tests

libbot/__init__.py

@@ -1,9 +1,6 @@
-__name__ = "libbot"
-__version__ = "1.9"
+__version__ = "0.2.0"
 __license__ = "GPL3"
 __author__ = "Profitroll"
 
+from . import i18n, pyrogram, sync
 from .__main__ import *
-from . import sync
-from . import i18n
-from . import pyrogram

libbot/i18n/__init__.py

@@ -2,14 +2,15 @@ from os import listdir
 from pathlib import Path
 from typing import Any, Dict, Union
 
-from libbot import config_get, json_read, sync
+import libbot
+from libbot.i18n import sync
 from libbot.i18n.classes.bot_locale import BotLocale
 
 
 async def _(
     key: str,
     *args: str,
-    locale: str = "en",
+    locale: Union[str, None] = "en",
     locales_root: Union[str, Path] = Path("locale"),
 ) -> Any:
     """Get value of locale string
@@ -17,20 +18,20 @@ async def _(
     ### 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 `"en"`.
+        * locale (`Union[str, None]`): Locale to looked up in. Defaults to `"en"`.
         * 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`
     """
-    locale = sync.config_get("locale") if locale is None else locale
+    locale = libbot.sync.config_get("locale") if locale is None else locale
 
     try:
-        this_dict = await json_read(Path(f"{locales_root}/{locale}.json"))
+        this_dict = await libbot.json_read(Path(f"{locales_root}/{locale}.json"))
     except FileNotFoundError:
         try:
-            this_dict = await json_read(
-                Path(f'{locales_root}/{await config_get("locale")}.json')
+            this_dict = await libbot.json_read(
+                Path(f'{locales_root}/{await libbot.config_get("locale")}.json')
             )
         except FileNotFoundError:
             return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
@@ -65,7 +66,7 @@ async def in_all_locales(
     valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
     for lc in valid_locales:
         try:
-            this_dict = await json_read(Path(f"{locales_root}/{lc}.json"))
+            this_dict = await libbot.json_read(Path(f"{locales_root}/{lc}.json"))
         except FileNotFoundError:
             continue
 
@@ -101,7 +102,7 @@ async def in_every_locale(
     valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
     for lc in valid_locales:
         try:
-            this_dict = await json_read(Path(f"{locales_root}/{lc}.json"))
+            this_dict = await libbot.json_read(Path(f"{locales_root}/{lc}.json"))
         except FileNotFoundError:
             continue
 

libbot/i18n/classes/bot_locale.py

@@ -10,6 +10,7 @@ class BotLocale:
 
     def __init__(
         self,
+        default_locale: Union[str, None] = "en",
         locales_root: Union[str, Path] = Path("locale"),
     ) -> None:
         if isinstance(locales_root, str):
@@ -23,7 +24,9 @@ class BotLocale:
             ".".join(entry.split(".")[:-1]) for entry in files_locales
         ]
 
-        self.default: str = sync.config_get("locale")
+        self.default: str = (
+            sync.config_get("locale") if default_locale is None else default_locale
+        )
         self.locales: dict = {}
 
         for lc in valid_locales:

libbot/i18n/sync/__init__.py

@@ -2,14 +2,13 @@ from os import listdir
 from pathlib import Path
 from typing import Any, Dict, Union
 
-from libbot import sync
-from libbot.sync import config_get, json_read
+import libbot
 
 
 def _(
     key: str,
     *args: str,
-    locale: str = "en",
+    locale: Union[str, None] = "en",
     locales_root: Union[str, Path] = Path("locale"),
 ) -> Any:
     """Get value of locale string
@@ -17,20 +16,22 @@ def _(
     ### 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 `"en"`.
+        * locale (`Union[str, None]`): Locale to looked up in. Defaults to `"en"`.
         * 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`
     """
     if locale is None:
-        locale = sync.config_get("locale")
+        locale = libbot.sync.config_get("locale")
 
     try:
-        this_dict = json_read(Path(f"{locales_root}/{locale}.json"))
+        this_dict = libbot.sync.json_read(Path(f"{locales_root}/{locale}.json"))
     except FileNotFoundError:
         try:
-            this_dict = json_read(Path(f'{locales_root}/{config_get("locale")}.json'))
+            this_dict = libbot.sync.json_read(
+                Path(f'{locales_root}/{libbot.sync.config_get("locale")}.json')
+            )
         except FileNotFoundError:
             return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
 
@@ -64,7 +65,7 @@ def in_all_locales(
     valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
     for lc in valid_locales:
         try:
-            this_dict = json_read(Path(f"{locales_root}/{lc}.json"))
+            this_dict = libbot.sync.json_read(Path(f"{locales_root}/{lc}.json"))
         except FileNotFoundError:
             continue
 
@@ -100,7 +101,7 @@ def in_every_locale(
     valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
     for lc in valid_locales:
         try:
-            this_dict = json_read(Path(f"{locales_root}/{lc}.json"))
+            this_dict = libbot.sync.json_read(Path(f"{locales_root}/{lc}.json"))
         except FileNotFoundError:
             continue
 

libbot/sync/__init__.py

@@ -55,7 +55,9 @@ def nested_set(target: dict, value: Any, *path: str, create_missing=True) -> dic
         elif create_missing:
             d = d.setdefault(key, {})
         else:
-            return target
+            raise KeyError(
+                f"Key '{key}' is not found under path provided ({path}) and create_missing is False"
+            )
     if path[-1] in d or create_missing:
         d[path[-1]] = value
     return target

pyproject.toml

@@ -4,12 +4,12 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "libbot"
-version = "1.9"
+version = "0.2.0"
 authors = [{ name = "Profitroll" }]
 description = "Universal bot library with functions needed for basic Discord/Telegram bot development."
 readme = "README.md"
 requires-python = ">=3.8"
-license = { text = "GPL3" }
+license = { file = "LICENSE" }
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Intended Audience :: Developers",

setup.cfg

@@ -1,3 +0,0 @@
-[metadata]
-description_file=README.md
-license_files=LICENSE

setup.py

@@ -1,4 +0,0 @@
-from setuptools import setup
-
-if __name__ == "__main__":
-    setup()

tests/data/locale/en.json

@@ -0,0 +1,11 @@
+{
+    "foo": "bar",
+    "messages": {
+        "example": "okay"
+    },
+    "callbacks": {
+        "default": {
+            "nested": "sure"
+        }
+    }
+}

tests/data/locale/uk.json

@@ -0,0 +1,11 @@
+{
+    "foo": "бар",
+    "messages": {
+        "example": "окей"
+    },
+    "callbacks": {
+        "default": {
+            "nested": "авжеж"
+        }
+    }
+}

tests/test_bot_locale.py

@@ -0,0 +1,53 @@
+from pathlib import Path
+from typing import Any, List, Union
+
+import pytest
+
+from libbot.i18n import BotLocale
+
+bot_locale = BotLocale(Path("tests/data/locale"))
+
+
+@pytest.mark.parametrize(
+    "key, args, locale, expected",
+    [
+        ("foo", [], None, "bar"),
+        ("foo", [], "uk", "бар"),
+        ("example", ["messages"], None, "okay"),
+        ("example", ["messages"], "uk", "окей"),
+        ("nested", ["callbacks", "default"], None, "sure"),
+        ("nested", ["callbacks", "default"], "uk", "авжеж"),
+    ],
+)
+def test_bot_locale_get(
+    key: str, args: List[str], locale: Union[str, None], expected: Any
+):
+    assert (
+        bot_locale._(key, *args, locale=locale)
+        if locale is not None
+        else bot_locale._(key, *args)
+    ) == expected
+
+
+@pytest.mark.parametrize(
+    "key, args, expected",
+    [
+        ("foo", [], ["bar", "бар"]),
+        ("example", ["messages"], ["okay", "окей"]),
+        ("nested", ["callbacks", "default"], ["sure", "авжеж"]),
+    ],
+)
+def test_i18n_in_all_locales(key: str, args: List[str], expected: Any):
+    assert (bot_locale.in_all_locales(key, *args)) == expected
+
+
+@pytest.mark.parametrize(
+    "key, args, expected",
+    [
+        ("foo", [], {"en": "bar", "uk": "бар"}),
+        ("example", ["messages"], {"en": "okay", "uk": "окей"}),
+        ("nested", ["callbacks", "default"], {"en": "sure", "uk": "авжеж"}),
+    ],
+)
+def test_i18n_in_every_locale(key: str, args: List[str], expected: Any):
+    assert (bot_locale.in_every_locale(key, *args)) == expected

tests/test_i18n_async.py

@@ -0,0 +1,58 @@
+from pathlib import Path
+from typing import Any, List, Union
+
+import pytest
+
+from libbot import i18n
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "key, args, locale, expected",
+    [
+        ("foo", [], None, "bar"),
+        ("foo", [], "uk", "бар"),
+        ("example", ["messages"], None, "okay"),
+        ("example", ["messages"], "uk", "окей"),
+        ("nested", ["callbacks", "default"], None, "sure"),
+        ("nested", ["callbacks", "default"], "uk", "авжеж"),
+    ],
+)
+async def test_i18n_get(
+    key: str, args: List[str], locale: Union[str, None], expected: Any
+):
+    assert (
+        await i18n._(key, *args, locale=locale, locales_root=Path("tests/data/locale"))
+        if locale is not None
+        else await i18n._(key, *args, locales_root=Path("tests/data/locale"))
+    ) == expected
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "key, args, expected",
+    [
+        ("foo", [], ["bar", "бар"]),
+        ("example", ["messages"], ["okay", "окей"]),
+        ("nested", ["callbacks", "default"], ["sure", "авжеж"]),
+    ],
+)
+async def test_i18n_in_all_locales(key: str, args: List[str], expected: Any):
+    assert (
+        await i18n.in_all_locales(key, *args, locales_root=Path("tests/data/locale"))
+    ) == expected
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "key, args, expected",
+    [
+        ("foo", [], {"en": "bar", "uk": "бар"}),
+        ("example", ["messages"], {"en": "okay", "uk": "окей"}),
+        ("nested", ["callbacks", "default"], {"en": "sure", "uk": "авжеж"}),
+    ],
+)
+async def test_i18n_in_every_locale(key: str, args: List[str], expected: Any):
+    assert (
+        await i18n.in_every_locale(key, *args, locales_root=Path("tests/data/locale"))
+    ) == expected

tests/test_i18n_sync.py

@@ -0,0 +1,53 @@
+from pathlib import Path
+from typing import Any, List, Union
+
+import pytest
+
+from libbot.i18n import sync
+
+
+@pytest.mark.parametrize(
+    "key, args, locale, expected",
+    [
+        ("foo", [], None, "bar"),
+        ("foo", [], "uk", "бар"),
+        ("example", ["messages"], None, "okay"),
+        ("example", ["messages"], "uk", "окей"),
+        ("nested", ["callbacks", "default"], None, "sure"),
+        ("nested", ["callbacks", "default"], "uk", "авжеж"),
+    ],
+)
+def test_i18n_get(key: str, args: List[str], locale: Union[str, None], expected: Any):
+    assert (
+        sync._(key, *args, locale=locale, locales_root=Path("tests/data/locale"))
+        if locale is not None
+        else sync._(key, *args, locales_root=Path("tests/data/locale"))
+    ) == expected
+
+
+@pytest.mark.parametrize(
+    "key, args, expected",
+    [
+        ("foo", [], ["bar", "бар"]),
+        ("example", ["messages"], ["okay", "окей"]),
+        ("nested", ["callbacks", "default"], ["sure", "авжеж"]),
+    ],
+)
+def test_i18n_in_all_locales(key: str, args: List[str], expected: Any):
+    assert (
+        sync.in_all_locales(key, *args, locales_root=Path("tests/data/locale"))
+    ) == expected
+
+
+@pytest.mark.parametrize(
+    "key, args, expected",
+    [
+        ("foo", [], {"en": "bar", "uk": "бар"}),
+        ("example", ["messages"], {"en": "okay", "uk": "окей"}),
+        ("nested", ["callbacks", "default"], {"en": "sure", "uk": "авжеж"}),
+    ],
+)
+def test_i18n_in_every_locale(key: str, args: List[str], expected: Any):
+    assert (
+        sync.in_every_locale(key, *args, locales_root=Path("tests/data/locale"))
+    ) == expected

tests/test_nested_set.py

@@ -0,0 +1,63 @@
+from typing import Any, List
+
+import pytest
+
+from libbot import sync
+
+
+@pytest.mark.parametrize(
+    "target, value, path, create_missing, expected",
+    [
+        ({"foo": "bar"}, "rab", ["foo"], True, {"foo": "rab"}),
+        ({"foo": "bar"}, {"123": 456}, ["foo"], True, {"foo": {"123": 456}}),
+        (
+            {"foo": {"bar": {}}},
+            True,
+            ["foo", "bar", "test"],
+            True,
+            {"foo": {"bar": {"test": True}}},
+        ),
+        (
+            {"foo": {"bar": {}}},
+            True,
+            ["foo", "bar", "test"],
+            False,
+            {"foo": {"bar": {}}},
+        ),
+    ],
+)
+def test_nested_set_valid(
+    target: dict[str, Any],
+    value: Any,
+    path: List[str],
+    create_missing: bool,
+    expected: Any,
+):
+    assert (
+        sync.nested_set(target, value, *path, create_missing=create_missing)
+    ) == expected
+
+
+@pytest.mark.parametrize(
+    "target, value, path, create_missing, expected",
+    [
+        (
+            {"foo": {"bar": {}}},
+            True,
+            ["foo", "bar", "test1", "test2"],
+            False,
+            KeyError,
+        ),
+    ],
+)
+def test_nested_set_invalid(
+    target: dict[str, Any],
+    value: Any,
+    path: List[str],
+    create_missing: bool,
+    expected: Any,
+):
+    with pytest.raises(expected):
+        assert (
+            sync.nested_set(target, value, *path, create_missing=create_missing)
+        ) == expected