libbot 4.2.0__tar.gz → 4.4.0__tar.gz

{libbot-4.2.0/src/libbot.egg-info → libbot-4.4.0}/PKG-INFO

@@ -1,15 +1,14 @@
 Metadata-Version: 2.4
 Name: libbot
-Version: 4.2.0
+Version: 4.4.0
 Summary: Universal bot library with functions needed for basic Discord/Telegram bot development.
 Author: Profitroll
-License: GPLv3
+License-Expression: GPL-3.0
 Project-URL: Source, https://git.end-play.xyz/profitroll/LibBotUniversal
 Project-URL: Documentation, https://git.end-play.xyz/profitroll/LibBotUniversal/wiki
 Project-URL: Tracker, https://git.end-play.xyz/profitroll/LibBotUniversal/issues
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -20,19 +19,19 @@ Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: aiofiles>=23.0.0
-Requires-Dist: typing-extensions~=4.13.0
+Requires-Dist: typing-extensions~=4.14.0
 Provides-Extra: dev
 Requires-Dist: black==25.1.0; extra == "dev"
 Requires-Dist: build==1.2.2.post1; extra == "dev"
 Requires-Dist: isort==5.13.2; extra == "dev"
-Requires-Dist: mypy==1.15.0; extra == "dev"
+Requires-Dist: mypy==1.16.1; extra == "dev"
 Requires-Dist: pylint==3.3.7; extra == "dev"
-Requires-Dist: pytest-asyncio==0.26.0; extra == "dev"
-Requires-Dist: pytest-cov==6.1.1; extra == "dev"
-Requires-Dist: pytest==8.3.5; extra == "dev"
-Requires-Dist: tox==4.26.0; extra == "dev"
+Requires-Dist: pytest-asyncio==1.0.0; extra == "dev"
+Requires-Dist: pytest-cov==6.2.1; extra == "dev"
+Requires-Dist: pytest==8.4.1; extra == "dev"
+Requires-Dist: tox==4.27.0; extra == "dev"
 Requires-Dist: twine==6.1.0; extra == "dev"
-Requires-Dist: types-aiofiles==24.1.0.20250516; extra == "dev"
+Requires-Dist: types-aiofiles==24.1.0.20250708; extra == "dev"
 Requires-Dist: types-ujson==5.10.0.20250326; extra == "dev"
 Provides-Extra: pycord
 Requires-Dist: apscheduler~=3.11.0; extra == "pycord"
@@ -44,7 +43,7 @@ Provides-Extra: speed
 Requires-Dist: ujson~=5.10.0; extra == "speed"
 Provides-Extra: cache
 Requires-Dist: pymemcache~=4.0.0; extra == "cache"
-Requires-Dist: redis~=6.1.0; extra == "cache"
+Requires-Dist: redis~=6.2.0; extra == "cache"
 Dynamic: license-file
 
 <h1 align="center">LibBotUniversal</h1>

{libbot-4.2.0 → libbot-4.4.0}/pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools>=62.6", "wheel"]
+requires = ["setuptools>=77.0.3", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -9,11 +9,11 @@ authors = [{ name = "Profitroll" }]
 description = "Universal bot library with functions needed for basic Discord/Telegram bot development."
 readme = "README.md"
 requires-python = ">=3.11"
-license = { text = "GPLv3" }
+license = "GPL-3.0"
+license-files = ["LICENSE"]
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Intended Audience :: Developers",
-    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",

libbot-4.4.0/requirements/_.txt

@@ -0,0 +1,2 @@
+aiofiles>=23.0.0
+typing-extensions~=4.14.0

{libbot-4.2.0 → libbot-4.4.0}/requirements/cache.txt

@@ -1,2 +1,2 @@
 pymemcache~=4.0.0
-redis~=6.1.0
+redis~=6.2.0

libbot-4.4.0/requirements/dev.txt

@@ -0,0 +1,12 @@
+black==25.1.0
+build==1.2.2.post1
+isort==5.13.2
+mypy==1.16.1
+pylint==3.3.7
+pytest-asyncio==1.0.0
+pytest-cov==6.2.1
+pytest==8.4.1
+tox==4.27.0
+twine==6.1.0
+types-aiofiles==24.1.0.20250708
+types-ujson==5.10.0.20250326

{libbot-4.2.0 → libbot-4.4.0}/src/libbot/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "4.2.0"
+__version__ = "4.4.0"
 __license__ = "GPL3"
 __author__ = "Profitroll"
 

{libbot-4.2.0 → libbot-4.4.0}/src/libbot/cache/classes/cache.py

@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from typing import Any, Dict
+from typing import Any, Dict, Optional
 
 import pymemcache
 import redis
@@ -27,16 +27,16 @@ class Cache(ABC):
         pass
 
     @abstractmethod
-    def set_json(self, key: str, value: Any) -> None:
+    def set_json(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
         # TODO This method must also carry out ObjectId conversion!
         pass
 
     @abstractmethod
-    def set_string(self, key: str, value: str) -> None:
+    def set_string(self, key: str, value: str, ttl_seconds: Optional[int] = None) -> None:
         pass
 
     @abstractmethod
-    def set_object(self, key: str, value: Any) -> None:
+    def set_object(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
         pass
 
     @abstractmethod

{libbot-4.2.0 → libbot-4.4.0}/src/libbot/cache/classes/cache_memcached.py

@@ -13,20 +13,23 @@ logger: Logger = logging.getLogger(__name__)
 class CacheMemcached(Cache):
     client: Client
 
-    def __init__(self, client: Client, prefix: Optional[str] = None):
+    def __init__(
+        self, client: Client, prefix: Optional[str] = None, default_ttl_seconds: Optional[int] = None
+    ) -> None:
         self.client: Client = client
         self.prefix: str | None = prefix
+        self.default_ttl_seconds: int = default_ttl_seconds if default_ttl_seconds is not None else 0
 
         logger.info("Initialized Memcached for caching")
 
     @classmethod
-    def from_config(cls, engine_config: Dict[str, Any], prefix: Optional[str] = None) -> "CacheMemcached":
+    def from_config(cls, engine_config: Dict[str, Any], prefix: Optional[str] = None, default_ttl_seconds: Optional[int] = None) -> "CacheMemcached":
         if "uri" not in engine_config:
             raise KeyError(
                 "Cache configuration is invalid. Please check if all keys are set (engine: memcached)"
             )
 
-        return cls(Client(engine_config["uri"], default_noreply=True), prefix=prefix)
+        return cls(Client(engine_config["uri"], default_noreply=True), prefix=prefix, default_ttl_seconds=default_ttl_seconds)
 
     def _get_prefixed_key(self, key: str) -> str:
         return key if self.prefix is None else f"{self.prefix}_{key}"
@@ -69,28 +72,34 @@ class CacheMemcached(Cache):
     def get_object(self, key: str) -> Any | None:
         raise NotImplementedError()
 
-    def set_json(self, key: str, value: Any) -> None:
+    def set_json(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
         key = self._get_prefixed_key(key)
 
         try:
-            self.client.set(key, _json_to_string(value))
+            self.client.set(
+                key,
+                _json_to_string(value),
+                expire=self.default_ttl_seconds if ttl_seconds is None else ttl_seconds,
+            )
             logger.debug("Set json cache key '%s'", key)
         except Exception as exc:
             logger.error("Could not set json cache key '%s' due to: %s", key, exc)
             return None
 
-    def set_string(self, key: str, value: str) -> None:
+    def set_string(self, key: str, value: str, ttl_seconds: Optional[int] = None) -> None:
         key = self._get_prefixed_key(key)
 
         try:
-            self.client.set(key, value)
+            self.client.set(
+                key, value, expire=self.default_ttl_seconds if ttl_seconds is None else ttl_seconds
+            )
             logger.debug("Set string cache key '%s'", key)
         except Exception as exc:
             logger.error("Could not set string cache key '%s' due to: %s", key, exc)
             return None
 
     # TODO Implement binary serialization
-    def set_object(self, key: str, value: Any) -> None:
+    def set_object(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
         raise NotImplementedError()
 
     def delete(self, key: str) -> None:

{libbot-4.2.0 → libbot-4.4.0}/src/libbot/cache/classes/cache_redis.py

@@ -5,7 +5,7 @@ from typing import Dict, Any, Optional
 from redis import Redis
 
 from .cache import Cache
-from ..utils._objects import _string_to_json, _json_to_string
+from ..utils._objects import _json_to_string, _string_to_json
 
 logger: Logger = logging.getLogger(__name__)
 
@@ -13,20 +13,23 @@ logger: Logger = logging.getLogger(__name__)
 class CacheRedis(Cache):
     client: Redis
 
-    def __init__(self, client: Redis, prefix: Optional[str] = None):
+    def __init__(
+        self, client: Redis, prefix: Optional[str] = None, default_ttl_seconds: Optional[int] = None
+    ) -> None:
         self.client: Redis = client
         self.prefix: str | None = prefix
+        self.default_ttl_seconds: int | None = default_ttl_seconds
 
         logger.info("Initialized Redis for caching")
 
     @classmethod
-    def from_config(cls, engine_config: Dict[str, Any], prefix: Optional[str] = None) -> Any:
+    def from_config(cls, engine_config: Dict[str, Any], prefix: Optional[str] = None, default_ttl_seconds: Optional[int] = None) -> Any:
         if "uri" not in engine_config:
             raise KeyError(
                 "Cache configuration is invalid. Please check if all keys are set (engine: memcached)"
             )
 
-        return cls(Redis.from_url(engine_config["uri"]), prefix=prefix)
+        return cls(Redis.from_url(engine_config["uri"]), prefix=prefix, default_ttl_seconds=default_ttl_seconds)
 
     def _get_prefixed_key(self, key: str) -> str:
         return key if self.prefix is None else f"{self.prefix}_{key}"
@@ -69,28 +72,32 @@ class CacheRedis(Cache):
     def get_object(self, key: str) -> Any | None:
         raise NotImplementedError()
 
-    def set_json(self, key: str, value: Any) -> None:
+    def set_json(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
         key = self._get_prefixed_key(key)
 
         try:
-            self.client.set(key, _json_to_string(value))
+            self.client.set(
+                key,
+                _json_to_string(value),
+                ex=self.default_ttl_seconds if ttl_seconds is None else ttl_seconds,
+            )
             logger.debug("Set json cache key '%s'", key)
         except Exception as exc:
             logger.error("Could not set json cache key '%s' due to: %s", key, exc)
             return None
 
-    def set_string(self, key: str, value: str) -> None:
+    def set_string(self, key: str, value: str, ttl_seconds: Optional[int] = None) -> None:
         key = self._get_prefixed_key(key)
 
         try:
-            self.client.set(key, value)
+            self.client.set(key, value, ex=self.default_ttl_seconds if ttl_seconds is None else ttl_seconds)
             logger.debug("Set string cache key '%s'", key)
         except Exception as exc:
             logger.error("Could not set string cache key '%s' due to: %s", key, exc)
             return None
 
     # TODO Implement binary serialization
-    def set_object(self, key: str, value: Any) -> None:
+    def set_object(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
         raise NotImplementedError()
 
     def delete(self, key: str) -> None:

{libbot-4.2.0 → libbot-4.4.0}/src/libbot/cache/manager/manager.py

@@ -7,7 +7,19 @@ def create_cache_client(
     config: Dict[str, Any],
     engine: Literal["memcached", "redis"] | None = None,
     prefix: Optional[str] = None,
+    default_ttl_seconds: Optional[int] = None,
 ) -> CacheMemcached | CacheRedis:
+    """Create a cache client of a provided type.
+
+    Args:
+        config (Dict[str, Any]): Cache client configuration.
+        engine (Literal["memcached", "redis"] | None): Cache engine to use. Defaults to None.
+        prefix (:obj:`str`, optional): Prefix used for each key-value pair. Defaults to None (no prefix).
+        default_ttl_seconds (:obj:`int`, optional): Default TTL for values (in seconds). Defaults to None (does not expire).
+
+    Returns:
+        CacheMemcached | CacheRedis: Cache client.
+    """
     if engine not in ["memcached", "redis"] or engine is None:
         raise KeyError(f"Incorrect cache engine provided. Expected 'memcached' or 'redis', got '{engine}'")
 
@@ -18,8 +30,8 @@ def create_cache_client(
 
     match engine:
         case "memcached":
-            return CacheMemcached.from_config(config["cache"][engine], prefix=prefix)
+            return CacheMemcached.from_config(config["cache"][engine], prefix=prefix, default_ttl_seconds=default_ttl_seconds)
         case "redis":
-            return CacheRedis.from_config(config["cache"][engine], prefix=prefix)
+            return CacheRedis.from_config(config["cache"][engine], prefix=prefix, default_ttl_seconds=default_ttl_seconds)
         case _:
             raise KeyError(f"Cache implementation for the engine '{engine}' is not present.")

{libbot-4.2.0 → libbot-4.4.0}/src/libbot/i18n/_functions.py

@@ -18,16 +18,16 @@ def _(
     locale: str | None = "en",
     locales_root: str | Path = Path("locale"),
 ) -> Any:
-    """Get value of locale string
+    """Get value of locale string.
 
-    ### Args:
-        * key (`str`): The last key of the locale's keys path.
-        * *args (`str`): Path to key like: `dict[args][key]`.
-        * locale (`str | None`): Locale to looked up in. Defaults to `"en"`.
-        * locales_root (`str | Path`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
+    Args:
+        key (str): The last key of the locale's keys path.
+        *args (str): Path to key like: `dict[args][key]`.
+        locale (str | None): Locale to looked up in. Defaults to "en".
+        locales_root (str | Path, optional): Folder where locales are located. Defaults to Path("locale").
 
-    ### Returns:
-        * `Any`: Value of provided locale key. Is usually `str`, `Dict[str, Any]` or `List[Any]`
+    Returns:
+        Any: Value of provided locale key. Is usually `str`, `Dict[str, Any]` or `List[Any]`.
     """
     if locale is None:
         locale: str = config_get("locale")
@@ -58,16 +58,16 @@ async def _(
     locale: str | None = "en",
     locales_root: str | Path = Path("locale"),
 ) -> Any:
-    """Get value of locale string
+    """Get value of locale string.
 
-    ### Args:
-        * key (`str`): The last key of the locale's keys path.
-        * *args (`str`): Path to key like: `dict[args][key]`.
-        * locale (`str | None`): Locale to looked up in. Defaults to `"en"`.
-        * locales_root (`str | Path`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
+    Args:
+        key (str): The last key of the locale's keys path.
+        *args (str): Path to key like: `dict[args][key]`.
+        locale (str | None): Locale to looked up in. Defaults to "en".
+        locales_root (str | Path, optional): Folder where locales are located. Defaults to Path("locale").
 
-    ### Returns:
-        * `Any`: Value of provided locale key. Is usually `str`, `Dict[str, Any]` or `List[Any]`
+    Returns:
+        Any: Value of provided locale key. Is usually `str`, `Dict[str, Any]` or `List[Any]`.
     """
     locale: str = config_get("locale") if locale is None else locale
 
@@ -94,15 +94,15 @@ async def _(
 
 @asyncable
 def in_all_locales(key: str, *args: str, locales_root: str | Path = Path("locale")) -> List[Any]:
-    """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:
-        * key (`str`): The last key of the locale's keys path.
-        * *args (`str`): Path to key like: `dict[args][key]`.
-        * locales_root (`str | Path`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
+    Args:
+        key (str): The last key of the locale's keys path.
+        *args (str): Path to key like: `dict[args][key]`.
+        locales_root (str | Path, optional): Folder where locales are located. Defaults to `Path("locale")`.
 
-    ### Returns:
-        * `List[Any]`: List of values in all locales
+    Returns:
+        List[Any]: List of values in all locales.
     """
 
     output: List[Any] = []
@@ -128,15 +128,15 @@ def in_all_locales(key: str, *args: str, locales_root: str | Path = Path("locale
 
 @in_all_locales.asynchronous
 async def in_all_locales(key: str, *args: str, locales_root: str | Path = Path("locale")) -> List[Any]:
-    """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:
-        * key (`str`): The last key of the locale's keys path.
-        * *args (`str`): Path to key like: `dict[args][key]`.
-        * locales_root (`str | Path`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
+    Args:
+        key (str): The last key of the locale's keys path.
+        *args (str): Path to key like: `dict[args][key]`.
+        locales_root (str | Path, optional): Folder where locales are located. Defaults to Path("locale").
 
-    ### Returns:
-        * `List[Any]`: List of values in all locales
+    Returns:
+        List[Any]: List of values in all locales.
     """
 
     output: List[Any] = []
@@ -164,15 +164,15 @@ async def in_all_locales(key: str, *args: str, locales_root: str | Path = Path("
 def in_every_locale(
     key: str, *args: str, locales_root: 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:
-        * key (`str`): The last key of the locale's keys path.
-        * *args (`str`): Path to key like: `dict[args][key]`.
-        * locales_root (`str | Path`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
+    Args:
+        key (str): The last key of the locale's keys path.
+        *args (str): Path to key like: `dict[args][key]`.
+        locales_root (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
+    Returns:
+        Dict[str, Any]: Locale is a key, and it's value from locale file is a value.
     """
 
     output: Dict[str, Any] = {}
@@ -200,15 +200,15 @@ def in_every_locale(
 async def in_every_locale(
     key: str, *args: str, locales_root: 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:
-        * key (`str`): The last key of the locale's keys path.
-        * *args (`str`): Path to key like: `dict[args][key]`.
-        * locales_root (`str | Path`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
+    Args:
+        key (str): The last key of the locale's keys path.
+        *args (str): Path to key like: `dict[args][key]`.
+        locales_root (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
+    Returns:
+        Dict[str, Any]: Locale is a key, and it's value from locale file is a value.
     """
 
     output: Dict[str, Any] = {}

{libbot-4.2.0 → libbot-4.4.0}/src/libbot/i18n/classes/bot_locale.py

@@ -14,6 +14,11 @@ class BotLocale:
         default_locale: str | None = "en",
         locales_root: str | Path = Path("locale"),
     ) -> None:
+        """
+        Args:
+            default_locale (str | None, optional): Default locale. Defaults to "en".
+            locales_root (str | Path, optional): Path to a directory with locale files. Defaults to Path("locale").
+        """
         if isinstance(locales_root, str):
             locales_root = Path(locales_root)
         elif not isinstance(locales_root, Path):
@@ -30,15 +35,15 @@ class BotLocale:
             self.locales[locale] = json_read(Path(f"{locales_root}/{locale}.json"))
 
     def _(self, key: str, *args: str, locale: str | None = None) -> Any:
-        """Get value of locale string
+        """Get value of locale string.
 
-        ### Args:
-            * key (`str`): The last key of the locale's keys path
-            * *args (`str`): Path to key like: `dict[args][key]`
-            * locale (`str | None`, *optional*): Locale to looked up in. Defaults to config's `"locale"` value
+        Args:
+            key (str): The last key of the locale's keys path.
+            *args (str): Path to key like: `dict[args][key]`.
+            locale (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[str, Any]` or `List[Any]`
+        Returns:
+            Any: Value of provided locale key. Is usually `str`, `Dict[str, Any]` or `List[Any]`.
         """
         if locale is None:
             locale: str = self.default
@@ -64,14 +69,14 @@ class BotLocale:
             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[Any]:
-        """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:
-            * key (`str`): The last key of the locale's keys path.
-            * *args (`str`): Path to key like: `dict[args][key]`.
+        Args:
+            key (str): The last key of the locale's keys path.
+            *args (str): Path to key like: `dict[args][key]`.
 
-        ### Returns:
-            * `List[Any]`: List of values in all locales
+        Returns:
+            List[Any]: List of values in all locales.
         """
         output: List[Any] = []
 
@@ -94,14 +99,14 @@ class BotLocale:
         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
+        """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 (`str`): Path to key like: `dict[args][key]`.
+        Args:
+            key (str): The last key of the locale's keys path.
+            *args (str): 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
+        Returns:
+            Dict[str, Any]: Locale is a key, and it's value from locale file is a value.
         """
         output: Dict[str, Any] = {}