Compare commits

...

7 Commits
v0.7 ... v1.0

Author SHA1 Message Date
20d47dc3d3 Completely removed Python 3.7 support 2023-06-20 12:41:40 +02:00
931f014242 Updated to 1.0 2023-06-20 12:41:00 +02:00
d352452d94 Fixed package bug 2023-06-20 12:40:44 +02:00
bba0aca25a Updated to 0.9 2023-06-20 12:31:21 +02:00
0d93e08397 Added BotLocale class 2023-06-20 12:30:27 +02:00
b21f7044eb Bump Python version to >=3.8 and version to 0.8 2023-06-13 10:55:44 +02:00
0cdd887e63 Dump ujson to ~=5.8.0 2023-06-13 11:53:56 +03:00
4 changed files with 134 additions and 7 deletions

View File

@@ -1,5 +1,5 @@
__name__ = "libbot" __name__ = "libbot"
__version__ = "0.7" __version__ = "1.0"
__license__ = "GPL3" __license__ = "GPL3"
__author__ = "Profitroll" __author__ = "Profitroll"

View File

@@ -3,6 +3,7 @@ from pathlib import Path
from typing import Any, Dict from typing import Any, Dict
from libbot import config_get, json_read, sync from libbot import config_get, json_read, sync
from libbot.i18n.classes.bot_locale import BotLocale
async def _(key: str, *args: str, locale: str = sync.config_get("locale")) -> Any: async def _(key: str, *args: str, locale: str = sync.config_get("locale")) -> Any:

View File

@@ -0,0 +1,121 @@
from os import listdir
from pathlib import Path
from typing import Any, Dict, Union
from libbot import sync
class BotLocale:
"""Small addon that can be used by bot clients' classes in order to minimize I/O"""
def __init__(self, locales_folder: Union[str, Path, None] = None) -> None:
if locales_folder is None:
locales_folder = Path(sync.config_get("locale", "locations"))
elif isinstance(locales_folder, str):
locales_folder = Path(locales_folder)
elif not isinstance(locales_folder, Path):
raise TypeError("'locales_folder' must be a valid path or path-like object")
files_locales: list = listdir(locales_folder)
valid_locales: list = [
".".join(entry.split(".")[:-1]) for entry in files_locales
]
self.default: str = sync.config_get("locale")
self.locales: dict = {}
for lc in valid_locales:
self.locales[lc] = sync.json_read(Path(f"{locales_folder}/{lc}.json"))
def _(self, key: str, *args: str, locale: Union[str, None] = None) -> 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 (`Union[str, None]`, *optional*): Locale to looked up in. Defaults to config's `"locale"` value
### Returns:
* `Any`: Value of provided locale key. Is usually `str`, `dict` or `list`
"""
if locale is None:
locale = self.default
try:
this_dict = self.locales[locale]
except KeyError:
try:
this_dict = self.locales[self.default]
except KeyError:
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
this_key = this_dict
for dict_key in args:
this_key = this_key[dict_key]
try:
return this_key[key]
except KeyError:
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
def in_all_locales(self, key: str, *args: str) -> 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]`.
### Returns:
* `list`: List of values in all locales
"""
output = []
for name, lc in self.locales.items():
try:
this_dict = lc
except KeyError:
continue
this_key = this_dict
for dict_key in args:
this_key = this_key[dict_key]
try:
output.append(this_key[key])
except KeyError:
continue
return output
def in_every_locale(self, key: str, *args: str) -> 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]`.
### Returns:
* `Dict[str, Any]`: Locale is a key and it's value from locale file is a value
"""
output = {}
for name, lc in self.locales.items():
try:
this_dict = lc
except KeyError:
continue
this_key = this_dict
for dict_key in args:
this_key = this_key[dict_key]
try:
output[name] = this_key[key]
except KeyError:
continue
return output

View File

@@ -4,18 +4,17 @@ build-backend = "setuptools.build_meta"
[project] [project]
name = "libbot" name = "libbot"
version = "0.7" version = "1.0"
authors = [{ name = "Profitroll" }] authors = [{ name = "Profitroll" }]
description = "Universal bot library with functions needed for basic Discord/Telegram bot development." description = "Universal bot library with functions needed for basic Discord/Telegram bot development."
readme = "README.md" readme = "README.md"
requires-python = ">=3.7" requires-python = ">=3.8"
license = { text = "GPL3" } license = { text = "GPL3" }
classifiers = [ classifiers = [
"Development Status :: 3 - Alpha", "Development Status :: 3 - Alpha",
"Intended Audience :: Developers", "Intended Audience :: Developers",
"License :: OSI Approved :: MIT License", "License :: OSI Approved :: MIT License",
"Operating System :: OS Independent", "Operating System :: OS Independent",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.10",
@@ -28,7 +27,7 @@ dependencies = ["aiofiles~=23.1.0"]
[project.optional-dependencies] [project.optional-dependencies]
pycord = ["py-cord>=2.0.0"] pycord = ["py-cord>=2.0.0"]
pyrogram = ["pyrogram>=2.0.0"] pyrogram = ["pyrogram>=2.0.0"]
speed = ["ujson==5.7.0"] speed = ["ujson~=5.8.0"]
[project.urls] [project.urls]
Source = "https://git.end-play.xyz/profitroll/LibBotUniversal" Source = "https://git.end-play.xyz/profitroll/LibBotUniversal"
@@ -36,12 +35,18 @@ Documentation = "https://git.end-play.xyz/profitroll/LibBotUniversal/wiki"
Tracker = "https://git.end-play.xyz/profitroll/LibBotUniversal/issues" Tracker = "https://git.end-play.xyz/profitroll/LibBotUniversal/issues"
[tool.setuptools] [tool.setuptools]
packages = ["libbot", "libbot.i18n", "libbot.sync", "libbot.i18n.sync"] packages = [
"libbot",
"libbot.i18n",
"libbot.sync",
"libbot.i18n.classes",
"libbot.i18n.sync",
]
[tool.setuptools_scm] [tool.setuptools_scm]
[tool.black] [tool.black]
target-version = ['py37', 'py38', 'py39', 'py310', 'py311'] target-version = ['py38', 'py38', 'py39', 'py310', 'py311']
[tool.isort] [tool.isort]
profile = "black" profile = "black"