Compare commits
6 Commits
Author | SHA1 | Date | |
---|---|---|---|
dc107ebdb3
|
|||
33c33d08e2
|
|||
295e77e403
|
|||
279a8e9d84
|
|||
ae374511cd
|
|||
eb23d3e9b6
|
@@ -1,5 +1,5 @@
|
|||||||
__name__ = "libbot"
|
__name__ = "libbot"
|
||||||
__version__ = "1.6"
|
__version__ = "1.9"
|
||||||
__license__ = "GPL3"
|
__license__ = "GPL3"
|
||||||
__author__ = "Profitroll"
|
__author__ = "Profitroll"
|
||||||
|
|
||||||
|
@@ -1,35 +1,36 @@
|
|||||||
from os import listdir
|
from os import listdir
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any, Dict
|
from typing import Any, Dict, Union
|
||||||
|
|
||||||
from libbot import config_get, json_read, sync
|
from libbot import config_get, json_read, sync
|
||||||
from libbot.i18n.classes.bot_locale import BotLocale
|
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"),
|
||||||
|
locales_root: Union[str, Path] = Path("locale"),
|
||||||
|
) -> Any:
|
||||||
"""Get value of locale string
|
"""Get value of locale string
|
||||||
|
|
||||||
### Args:
|
### Args:
|
||||||
* key (`str`): The last key of the locale's keys path
|
* key (`str`): The last key of the locale's keys path.
|
||||||
* *args (`list`): Path to key like: `dict[args][key]`
|
* *args (`list`): Path to key like: `dict[args][key]`.
|
||||||
* locale (`str`): Locale to looked up in. Defaults to config's `"locale"` value
|
* 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:
|
### Returns:
|
||||||
* `Any`: Value of provided locale key. Is usually `str`, `dict` or `list`
|
* `Any`: Value of provided locale key. Is usually `str`, `dict` or `list`
|
||||||
"""
|
"""
|
||||||
if locale is None:
|
locale = sync.config_get("locale") if locale is None else locale
|
||||||
locale = sync.config_get("locale")
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
this_dict = await json_read(
|
this_dict = await json_read(Path(f"{locales_root}/{locale}.json"))
|
||||||
Path(f'{await config_get("locale", "locations")}/{locale}.json')
|
|
||||||
)
|
|
||||||
except FileNotFoundError:
|
except FileNotFoundError:
|
||||||
try:
|
try:
|
||||||
this_dict = await json_read(
|
this_dict = await json_read(
|
||||||
Path(
|
Path(f'{locales_root}/{await config_get("locale")}.json')
|
||||||
f'{await config_get("locale", "locations")}/{await config_get("locale")}.json'
|
|
||||||
)
|
|
||||||
)
|
)
|
||||||
except FileNotFoundError:
|
except FileNotFoundError:
|
||||||
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
||||||
@@ -44,26 +45,27 @@ async def _(key: str, *args: str, locale: str = sync.config_get("locale")) -> An
|
|||||||
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
||||||
|
|
||||||
|
|
||||||
async def in_all_locales(key: str, *args: str) -> list:
|
async 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
|
"""Get value of the provided key and path in all available locales
|
||||||
|
|
||||||
### Args:
|
### Args:
|
||||||
* key (`str`): The last key of the locale's keys path.
|
* key (`str`): The last key of the locale's keys path.
|
||||||
* *args (`list`): Path to key like: `dict[args][key]`.
|
* *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:
|
### Returns:
|
||||||
* `list`: List of values in all locales
|
* `list`: List of values in all locales
|
||||||
"""
|
"""
|
||||||
|
|
||||||
output = []
|
output = []
|
||||||
files_locales = listdir(await config_get("locale", "locations"))
|
files_locales = listdir(locales_root)
|
||||||
|
|
||||||
valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
|
valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
|
||||||
for lc in valid_locales:
|
for lc in valid_locales:
|
||||||
try:
|
try:
|
||||||
this_dict = await json_read(
|
this_dict = await json_read(Path(f"{locales_root}/{lc}.json"))
|
||||||
Path(f'{await config_get("locale", "locations")}/{lc}.json')
|
|
||||||
)
|
|
||||||
except FileNotFoundError:
|
except FileNotFoundError:
|
||||||
continue
|
continue
|
||||||
|
|
||||||
@@ -79,26 +81,27 @@ async def in_all_locales(key: str, *args: str) -> list:
|
|||||||
return output
|
return output
|
||||||
|
|
||||||
|
|
||||||
async def in_every_locale(key: str, *args: str) -> Dict[str, Any]:
|
async 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
|
"""Get value of the provided key and path in every available locale with locale tag
|
||||||
|
|
||||||
### Args:
|
### Args:
|
||||||
* key (`str`): The last key of the locale's keys path.
|
* key (`str`): The last key of the locale's keys path.
|
||||||
* *args (`list`): Path to key like: `dict[args][key]`.
|
* *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:
|
### Returns:
|
||||||
* `Dict[str, Any]`: Locale is a key and it's value from locale file is a value
|
* `Dict[str, Any]`: Locale is a key and it's value from locale file is a value
|
||||||
"""
|
"""
|
||||||
|
|
||||||
output = {}
|
output = {}
|
||||||
files_locales = listdir(await config_get("locale", "locations"))
|
files_locales = listdir(locales_root)
|
||||||
|
|
||||||
valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
|
valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
|
||||||
for lc in valid_locales:
|
for lc in valid_locales:
|
||||||
try:
|
try:
|
||||||
this_dict = await json_read(
|
this_dict = await json_read(Path(f"{locales_root}/{lc}.json"))
|
||||||
Path(f'{await config_get("locale", "locations")}/{lc}.json')
|
|
||||||
)
|
|
||||||
except FileNotFoundError:
|
except FileNotFoundError:
|
||||||
continue
|
continue
|
||||||
|
|
||||||
|
@@ -8,15 +8,16 @@ from libbot import sync
|
|||||||
class BotLocale:
|
class BotLocale:
|
||||||
"""Small addon that can be used by bot clients' classes in order to minimize I/O"""
|
"""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:
|
def __init__(
|
||||||
if locales_folder is None:
|
self,
|
||||||
locales_folder = Path(sync.config_get("locale", "locations"))
|
locales_root: Union[str, Path] = Path("locale"),
|
||||||
elif isinstance(locales_folder, str):
|
) -> None:
|
||||||
locales_folder = Path(locales_folder)
|
if isinstance(locales_root, str):
|
||||||
elif not isinstance(locales_folder, Path):
|
locales_root = Path(locales_root)
|
||||||
raise TypeError("'locales_folder' must be a valid path or path-like object")
|
elif not isinstance(locales_root, Path):
|
||||||
|
raise TypeError("'locales_root' must be a valid path or path-like object")
|
||||||
|
|
||||||
files_locales: list = listdir(locales_folder)
|
files_locales: list = listdir(locales_root)
|
||||||
|
|
||||||
valid_locales: list = [
|
valid_locales: list = [
|
||||||
".".join(entry.split(".")[:-1]) for entry in files_locales
|
".".join(entry.split(".")[:-1]) for entry in files_locales
|
||||||
@@ -26,7 +27,7 @@ class BotLocale:
|
|||||||
self.locales: dict = {}
|
self.locales: dict = {}
|
||||||
|
|
||||||
for lc in valid_locales:
|
for lc in valid_locales:
|
||||||
self.locales[lc] = sync.json_read(Path(f"{locales_folder}/{lc}.json"))
|
self.locales[lc] = sync.json_read(Path(f"{locales_root}/{lc}.json"))
|
||||||
|
|
||||||
def _(self, key: str, *args: str, locale: Union[str, None] = None) -> Any:
|
def _(self, key: str, *args: str, locale: Union[str, None] = None) -> Any:
|
||||||
"""Get value of locale string
|
"""Get value of locale string
|
||||||
|
@@ -1,18 +1,24 @@
|
|||||||
from os import listdir
|
from os import listdir
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any, Dict
|
from typing import Any, Dict, Union
|
||||||
|
|
||||||
from libbot import sync
|
from libbot import sync
|
||||||
from libbot.sync import config_get, json_read
|
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
|
"""Get value of locale string
|
||||||
|
|
||||||
### Args:
|
### Args:
|
||||||
* key (`str`): The last key of the locale's keys path
|
* key (`str`): The last key of the locale's keys path.
|
||||||
* *args (`list`): Path to key like: `dict[args][key]`
|
* *args (`list`): Path to key like: `dict[args][key]`.
|
||||||
* locale (`str`): Locale to looked up in. Defaults to config's `"locale"` value
|
* 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:
|
### Returns:
|
||||||
* `Any`: Value of provided locale key. Is usually `str`, `dict` or `list`
|
* `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")
|
locale = sync.config_get("locale")
|
||||||
|
|
||||||
try:
|
try:
|
||||||
this_dict = json_read(
|
this_dict = json_read(Path(f"{locales_root}/{locale}.json"))
|
||||||
Path(f'{config_get("locale", "locations")}/{locale}.json')
|
|
||||||
)
|
|
||||||
except FileNotFoundError:
|
except FileNotFoundError:
|
||||||
try:
|
try:
|
||||||
this_dict = json_read(
|
this_dict = json_read(Path(f'{locales_root}/{config_get("locale")}.json'))
|
||||||
Path(f'{config_get("locale", "locations")}/{config_get("locale")}.json')
|
|
||||||
)
|
|
||||||
except FileNotFoundError:
|
except FileNotFoundError:
|
||||||
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
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}"'
|
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
|
"""Get value of the provided key and path in all available locales
|
||||||
|
|
||||||
### Args:
|
### Args:
|
||||||
* key (`str`): The last key of the locale's keys path.
|
* key (`str`): The last key of the locale's keys path.
|
||||||
* *args (`list`): Path to key like: `dict[args][key]`.
|
* *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:
|
### Returns:
|
||||||
* `list`: List of values in all locales
|
* `list`: List of values in all locales
|
||||||
"""
|
"""
|
||||||
|
|
||||||
output = []
|
output = []
|
||||||
files_locales = listdir(config_get("locale", "locations"))
|
files_locales = listdir(locales_root)
|
||||||
|
|
||||||
valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
|
valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
|
||||||
for lc in valid_locales:
|
for lc in valid_locales:
|
||||||
try:
|
try:
|
||||||
this_dict = json_read(
|
this_dict = json_read(Path(f"{locales_root}/{lc}.json"))
|
||||||
Path(f'{config_get("locale", "locations")}/{lc}.json')
|
|
||||||
)
|
|
||||||
except FileNotFoundError:
|
except FileNotFoundError:
|
||||||
continue
|
continue
|
||||||
|
|
||||||
@@ -77,26 +80,27 @@ def in_all_locales(key: str, *args: str) -> list:
|
|||||||
return output
|
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
|
"""Get value of the provided key and path in every available locale with locale tag
|
||||||
|
|
||||||
### Args:
|
### Args:
|
||||||
* key (`str`): The last key of the locale's keys path.
|
* key (`str`): The last key of the locale's keys path.
|
||||||
* *args (`list`): Path to key like: `dict[args][key]`.
|
* *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:
|
### Returns:
|
||||||
* `Dict[str, Any]`: Locale is a key and it's value from locale file is a value
|
* `Dict[str, Any]`: Locale is a key and it's value from locale file is a value
|
||||||
"""
|
"""
|
||||||
|
|
||||||
output = {}
|
output = {}
|
||||||
files_locales = listdir(config_get("locale", "locations"))
|
files_locales = listdir(locales_root)
|
||||||
|
|
||||||
valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
|
valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
|
||||||
for lc in valid_locales:
|
for lc in valid_locales:
|
||||||
try:
|
try:
|
||||||
this_dict = json_read(
|
this_dict = json_read(Path(f"{locales_root}/{lc}.json"))
|
||||||
Path(f'{config_get("locale", "locations")}/{lc}.json')
|
|
||||||
)
|
|
||||||
except FileNotFoundError:
|
except FileNotFoundError:
|
||||||
continue
|
continue
|
||||||
|
|
||||||
|
@@ -59,6 +59,7 @@ class PyroClient(Client):
|
|||||||
max_concurrent_transmissions: int = 1,
|
max_concurrent_transmissions: int = 1,
|
||||||
commands_source: Union[Dict[str, dict], None] = None,
|
commands_source: Union[Dict[str, dict], None] = None,
|
||||||
scheduler: Union[AsyncIOScheduler, BackgroundScheduler, None] = None,
|
scheduler: Union[AsyncIOScheduler, BackgroundScheduler, None] = None,
|
||||||
|
**kwargs,
|
||||||
):
|
):
|
||||||
if config is None:
|
if config is None:
|
||||||
with open(config_path, "r", encoding="utf-8") as f:
|
with open(config_path, "r", encoding="utf-8") as f:
|
||||||
@@ -90,6 +91,7 @@ class PyroClient(Client):
|
|||||||
]
|
]
|
||||||
if "max_concurrent_transmissions" in self.config["bot"]
|
if "max_concurrent_transmissions" in self.config["bot"]
|
||||||
else max_concurrent_transmissions,
|
else max_concurrent_transmissions,
|
||||||
|
**kwargs,
|
||||||
)
|
)
|
||||||
self.owner: int = self.config["bot"]["owner"]
|
self.owner: int = self.config["bot"]["owner"]
|
||||||
self.commands: List[PyroCommand] = []
|
self.commands: List[PyroCommand] = []
|
||||||
@@ -100,11 +102,7 @@ class PyroClient(Client):
|
|||||||
self.start_time: float = 0
|
self.start_time: float = 0
|
||||||
|
|
||||||
self.bot_locale: BotLocale = BotLocale(
|
self.bot_locale: BotLocale = BotLocale(
|
||||||
(
|
(Path("locale") if locales_root is None else locales_root)
|
||||||
Path(self.config["locations"]["locale"])
|
|
||||||
if locales_root is None
|
|
||||||
else locales_root
|
|
||||||
)
|
|
||||||
)
|
)
|
||||||
self.default_locale: str = self.bot_locale.default
|
self.default_locale: str = self.bot_locale.default
|
||||||
self.locales: dict = self.bot_locale.locales
|
self.locales: dict = self.bot_locale.locales
|
||||||
@@ -132,7 +130,9 @@ class PyroClient(Client):
|
|||||||
|
|
||||||
try:
|
try:
|
||||||
await self.send_message(
|
await self.send_message(
|
||||||
chat_id=self.config["reports"]["chat_id"],
|
chat_id=self.owner
|
||||||
|
if self.config["reports"]["chat_id"] == "owner"
|
||||||
|
else self.config["reports"]["chat_id"],
|
||||||
text=f"Bot started PID `{getpid()}`",
|
text=f"Bot started PID `{getpid()}`",
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -154,7 +154,9 @@ class PyroClient(Client):
|
|||||||
async def stop(self, exit_completely: bool = True):
|
async def stop(self, exit_completely: bool = True):
|
||||||
try:
|
try:
|
||||||
await self.send_message(
|
await self.send_message(
|
||||||
chat_id=self.config["reports"]["chat_id"],
|
chat_id=self.owner
|
||||||
|
if self.config["reports"]["chat_id"] == "owner"
|
||||||
|
else self.config["reports"]["chat_id"],
|
||||||
text=f"Bot stopped with PID `{getpid()}`",
|
text=f"Bot stopped with PID `{getpid()}`",
|
||||||
)
|
)
|
||||||
await asyncio.sleep(0.5)
|
await asyncio.sleep(0.5)
|
||||||
|
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
|||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "libbot"
|
name = "libbot"
|
||||||
version = "1.6"
|
version = "1.9"
|
||||||
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"
|
||||||
|
Reference in New Issue
Block a user