Compare commits
12 Commits
6038b5058f
...
v4.0.1
Author | SHA1 | Date | |
---|---|---|---|
bfcb067ba5 | |||
a38b55d270 | |||
9907cc50f1 | |||
1b60257bc5 | |||
171e36a491 | |||
c419c684aa | |||
748b2b2abb | |||
52c2e5cc13 | |||
55c61e3fce | |||
b9550032ba | |||
5ba763246b | |||
f0ffdf096d |
@@ -6,18 +6,19 @@ on:
|
||||
- main
|
||||
- dev
|
||||
pull_request:
|
||||
types: [ opened, synchronize, reopened ]
|
||||
types: [opened, synchronize, reopened]
|
||||
|
||||
jobs:
|
||||
sonarcloud:
|
||||
name: SonarCloud
|
||||
runs-on: ubuntu-24.04
|
||||
runs-on: ubuntu-latest
|
||||
container: catthehacker/ubuntu:act-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: SonarQube Scan
|
||||
uses: SonarSource/sonarqube-scan-action@v4.2.1
|
||||
- name: SonarCloud Scan
|
||||
uses: SonarSource/sonarcloud-github-action@master
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
@@ -1,67 +0,0 @@
|
||||
name: Upload Python Package
|
||||
|
||||
on:
|
||||
release:
|
||||
types: [ published ]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
release-build:
|
||||
runs-on: ubuntu-24.04
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: "3.x"
|
||||
- name: Build release distributions
|
||||
run: |
|
||||
python -m pip install build
|
||||
python -m build
|
||||
- name: Upload distributions
|
||||
uses: christopherhx/gitea-upload-artifact@v4
|
||||
with:
|
||||
name: release-dists
|
||||
path: dist/
|
||||
gitea-publish:
|
||||
runs-on: ubuntu-24.04
|
||||
needs: release-build
|
||||
permissions:
|
||||
id-token: write
|
||||
environment:
|
||||
name: gitea
|
||||
url: https://git.end-play.xyz/profitroll/-/packages/pypi/libbot
|
||||
env:
|
||||
GITHUB_WORKFLOW_REF: ${{ gitea.workflow_ref }}
|
||||
INPUT_REPOSITORY_URL: https://git.end-play.xyz/api/packages/profitroll/pypi
|
||||
steps:
|
||||
- name: Retrieve release distributions
|
||||
uses: christopherhx/gitea-download-artifact@v4
|
||||
with:
|
||||
name: release-dists
|
||||
path: dist/
|
||||
- name: Publish package distributions to TestPyPI
|
||||
uses: pypa/gh-action-pypi-publish@release/v1
|
||||
with:
|
||||
password: ${{ secrets.PYPI_GITEA_API_TOKEN }}
|
||||
repository-url: https://git.end-play.xyz/api/packages/profitroll/pypi
|
||||
pypi-publish:
|
||||
runs-on: ubuntu-24.04
|
||||
needs: release-build
|
||||
permissions:
|
||||
id-token: write
|
||||
environment:
|
||||
name: pypi
|
||||
env:
|
||||
GITHUB_WORKFLOW_REF: ${{ gitea.workflow_ref }}
|
||||
steps:
|
||||
- name: Retrieve release distributions
|
||||
uses: christopherhx/gitea-download-artifact@v4
|
||||
with:
|
||||
name: release-dists
|
||||
path: dist/
|
||||
- name: Publish package distributions to TestPyPI
|
||||
uses: pypa/gh-action-pypi-publish@release/v1
|
||||
with:
|
||||
password: ${{ secrets.PYPI_PYPI_API_TOKEN }}
|
@@ -11,18 +11,18 @@ on:
|
||||
jobs:
|
||||
test:
|
||||
name: Build and Test
|
||||
runs-on: ubuntu-24.04
|
||||
runs-on: ubuntu-latest
|
||||
container: catthehacker/ubuntu:act-latest
|
||||
strategy:
|
||||
matrix:
|
||||
python-version: [ "3.11", "3.12", "3.13" ]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- name: Set up Python ${{ matrix.python-version }}
|
||||
uses: actions/setup-python@v3
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
cache: 'pip'
|
||||
cache-dependency-path: './requirements/*'
|
||||
env:
|
||||
AGENT_TOOLSDIRECTORY: /opt/hostedtoolcache
|
||||
- name: Install dependencies
|
||||
|
10
README.md
10
README.md
@@ -16,7 +16,6 @@ There are different sub-packages available:
|
||||
* pyrogram - Telegram bots with Pyrogram's fork "Pyrofork"
|
||||
* pycord - Discord bots with Pycord
|
||||
* speed - Performance improvements
|
||||
* cache - Support for Redis and Memcached
|
||||
* dev - Dependencies for package development purposes
|
||||
|
||||
You can freely choose any sub-package you want, as well as add multiple (comma-separated) or none at all.
|
||||
@@ -37,8 +36,6 @@ pip install libbot[pycord,speed]
|
||||
### Pyrogram
|
||||
|
||||
```python
|
||||
import sys
|
||||
|
||||
from libbot.pyrogram.classes import PyroClient
|
||||
|
||||
|
||||
@@ -50,7 +47,7 @@ def main():
|
||||
except KeyboardInterrupt:
|
||||
print("Shutting down...")
|
||||
finally:
|
||||
sys.exit()
|
||||
exit()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
@@ -60,9 +57,6 @@ if __name__ == "__main__":
|
||||
### Pycord
|
||||
|
||||
```python
|
||||
import asyncio
|
||||
from asyncio import AbstractEventLoop
|
||||
|
||||
from discord import Intents
|
||||
from libbot.utils import config_get
|
||||
from libbot.pycord.classes import PycordBot
|
||||
@@ -82,7 +76,7 @@ async def main():
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
loop: AbstractEventLoop = asyncio.get_event_loop()
|
||||
loop = asyncio.get_event_loop()
|
||||
loop.run_until_complete(main())
|
||||
```
|
||||
|
||||
|
@@ -1,20 +0,0 @@
|
||||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line, and also
|
||||
# from the environment for the first two.
|
||||
SPHINXOPTS ?=
|
||||
SPHINXBUILD ?= sphinx-build
|
||||
SOURCEDIR = .
|
||||
BUILDDIR = _build
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
.PHONY: help Makefile
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
61
docs/conf.py
61
docs/conf.py
@@ -1,61 +0,0 @@
|
||||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# For the full list of built-in configuration values, see the documentation:
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||
import os
|
||||
import sys
|
||||
from datetime import datetime
|
||||
from typing import List, Dict, Any
|
||||
|
||||
import libbot
|
||||
|
||||
sys.path.insert(0, os.path.abspath(".."))
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
||||
|
||||
project: str = "LibBotUniversal"
|
||||
author: str = libbot.__author__
|
||||
version: str = libbot.__version__
|
||||
release: str = version
|
||||
copyright: str = f"{datetime.now().year} {author}"
|
||||
|
||||
html_title: str = f"{project} v{version} Documentation"
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||||
|
||||
extensions: List[str] = [
|
||||
"sphinx.ext.autodoc",
|
||||
"sphinx.ext.autosummary",
|
||||
"sphinx.ext.viewcode",
|
||||
"sphinx.ext.viewcode",
|
||||
"sphinx.ext.napoleon",
|
||||
"sphinx_copybutton",
|
||||
]
|
||||
|
||||
templates_path: List[str] = ["_templates"]
|
||||
exclude_patterns: List[str] = ["_build", "Thumbs.db", ".DS_Store"]
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
||||
|
||||
html_theme: str = "furo"
|
||||
html_static_path: List[str] = ["_static"]
|
||||
|
||||
html_theme_options: Dict[str, Any] = {
|
||||
"source_repository": "https://git.end-play.xyz/profitroll/LibBotUniversal",
|
||||
"source_branch": "main",
|
||||
"source_directory": "docs/",
|
||||
"light_css_variables": {
|
||||
"font-stack": "'Outfit', sans-serif",
|
||||
},
|
||||
}
|
||||
|
||||
resource_links: Dict[str, Any] = {
|
||||
"issues": "https://git.end-play.xyz/profitroll/LibBotUniversal/issues",
|
||||
"examples": "https://git.end-play.xyz/profitroll/LibBotUniversal/tree/main/examples",
|
||||
}
|
@@ -1,29 +0,0 @@
|
||||
Welcome to LibBotUniversal
|
||||
=============================
|
||||
|
||||
LibBotUniversal (AKA libbot) simplifies development and maintenance of different chatbots.
|
||||
|
||||
Getting started
|
||||
*****************************
|
||||
|
||||
There are a few pages to take a look at if you're just getting started.
|
||||
|
||||
* Installing the library
|
||||
* Creating your first bot
|
||||
* Examples of different bots
|
||||
|
||||
Getting help
|
||||
*****************************
|
||||
|
||||
If you are looking for help or want to report a bug, we got you covered.
|
||||
|
||||
* Bug reports are being submitted on the repo's issue tracker.
|
||||
|
||||
Package
|
||||
*****************************
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: API reference
|
||||
|
||||
modules
|
@@ -1,35 +0,0 @@
|
||||
@ECHO OFF
|
||||
|
||||
pushd %~dp0
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set SOURCEDIR=.
|
||||
set BUILDDIR=_build
|
||||
|
||||
%SPHINXBUILD% >NUL 2>NUL
|
||||
if errorlevel 9009 (
|
||||
echo.
|
||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||
echo.may add the Sphinx directory to PATH.
|
||||
echo.
|
||||
echo.If you don't have Sphinx installed, grab it from
|
||||
echo.https://www.sphinx-doc.org/
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||
goto end
|
||||
|
||||
:help
|
||||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||
|
||||
:end
|
||||
popd
|
@@ -1,7 +0,0 @@
|
||||
libbot
|
||||
======
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 5
|
||||
|
||||
libbot
|
@@ -1,4 +0,0 @@
|
||||
# Examples
|
||||
|
||||
If you're looking for Pyrogram usage examples, please take a look at
|
||||
the [PyrogramBotBase](https://git.end-play.xyz/profitroll/PyrogramBotBase) repository.
|
@@ -1,5 +1,5 @@
|
||||
[build-system]
|
||||
requires = ["setuptools>=77.0.3", "wheel"]
|
||||
requires = ["setuptools>=62.6", "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 = "GPL-3.0"
|
||||
license-files = ["LICENSE"]
|
||||
license = { text = "GPLv3" }
|
||||
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",
|
||||
@@ -28,11 +28,9 @@ dependencies = { file = "requirements/_.txt" }
|
||||
|
||||
[tool.setuptools.dynamic.optional-dependencies]
|
||||
dev = { file = "requirements/dev.txt" }
|
||||
docs = { file = "requirements/docs.txt" }
|
||||
pycord = { file = "requirements/pycord.txt" }
|
||||
pyrogram = { file = "requirements/pyrogram.txt" }
|
||||
speed = { file = "requirements/speed.txt" }
|
||||
cache = { file = "requirements/cache.txt" }
|
||||
|
||||
[project.urls]
|
||||
Source = "https://git.end-play.xyz/profitroll/LibBotUniversal"
|
||||
|
@@ -1,2 +1,2 @@
|
||||
aiofiles>=23.0.0
|
||||
typing-extensions~=4.14.0
|
||||
typing_extensions~=4.12.2
|
@@ -1,2 +0,0 @@
|
||||
pymemcache~=4.0.0
|
||||
redis~=6.2.0
|
@@ -1,12 +1,12 @@
|
||||
black==25.1.0
|
||||
black==24.10.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.20250606
|
||||
types-ujson==5.10.0.20250326
|
||||
mypy==1.14.0
|
||||
pylint==3.3.3
|
||||
pytest-asyncio==0.25.0
|
||||
pytest-cov==6.0.0
|
||||
pytest==8.3.4
|
||||
tox==4.23.2
|
||||
twine==6.0.1
|
||||
types-aiofiles==24.1.0.20241221
|
||||
types-ujson==5.10.0.20240515
|
@@ -1,3 +0,0 @@
|
||||
furo==2024.8.6
|
||||
sphinx==8.1.3
|
||||
sphinx_copybutton==0.5.2
|
@@ -1,4 +1,4 @@
|
||||
__version__ = "4.3.0"
|
||||
__version__ = "4.0.1"
|
||||
__license__ = "GPL3"
|
||||
__author__ = "Profitroll"
|
||||
|
||||
|
2
src/libbot/cache/__init__.py
vendored
2
src/libbot/cache/__init__.py
vendored
@@ -1,2 +0,0 @@
|
||||
# This file is left empty on purpose
|
||||
# Adding imports here will cause import errors when libbot[pycord] is not installed
|
3
src/libbot/cache/classes/__init__.py
vendored
3
src/libbot/cache/classes/__init__.py
vendored
@@ -1,3 +0,0 @@
|
||||
from .cache import Cache
|
||||
from .cache_memcached import CacheMemcached
|
||||
from .cache_redis import CacheRedis
|
44
src/libbot/cache/classes/cache.py
vendored
44
src/libbot/cache/classes/cache.py
vendored
@@ -1,44 +0,0 @@
|
||||
from abc import ABC, abstractmethod
|
||||
from typing import Any, Dict, Optional
|
||||
|
||||
import pymemcache
|
||||
import redis
|
||||
|
||||
|
||||
class Cache(ABC):
|
||||
client: pymemcache.Client | redis.Redis
|
||||
|
||||
@classmethod
|
||||
@abstractmethod
|
||||
def from_config(cls, engine_config: Dict[str, Any]) -> Any:
|
||||
pass
|
||||
|
||||
@abstractmethod
|
||||
def get_json(self, key: str) -> Any | None:
|
||||
# TODO This method must also carry out ObjectId conversion!
|
||||
pass
|
||||
|
||||
@abstractmethod
|
||||
def get_string(self, key: str) -> str | None:
|
||||
pass
|
||||
|
||||
@abstractmethod
|
||||
def get_object(self, key: str) -> Any | None:
|
||||
pass
|
||||
|
||||
@abstractmethod
|
||||
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, ttl_seconds: Optional[int] = None) -> None:
|
||||
pass
|
||||
|
||||
@abstractmethod
|
||||
def set_object(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
|
||||
pass
|
||||
|
||||
@abstractmethod
|
||||
def delete(self, key: str) -> None:
|
||||
pass
|
112
src/libbot/cache/classes/cache_memcached.py
vendored
112
src/libbot/cache/classes/cache_memcached.py
vendored
@@ -1,112 +0,0 @@
|
||||
import logging
|
||||
from logging import Logger
|
||||
from typing import Dict, Any, Optional
|
||||
|
||||
from pymemcache import Client
|
||||
|
||||
from .cache import Cache
|
||||
from ..utils._objects import _json_to_string, _string_to_json
|
||||
|
||||
logger: Logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class CacheMemcached(Cache):
|
||||
client: Client
|
||||
|
||||
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":
|
||||
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)
|
||||
|
||||
def _get_prefixed_key(self, key: str) -> str:
|
||||
return key if self.prefix is None else f"{self.prefix}_{key}"
|
||||
|
||||
def get_json(self, key: str) -> Any | None:
|
||||
key = self._get_prefixed_key(key)
|
||||
|
||||
try:
|
||||
result: Any | None = self.client.get(key, None)
|
||||
|
||||
logger.debug(
|
||||
"Got json cache key '%s'%s",
|
||||
key,
|
||||
"" if result is not None else " (not found)",
|
||||
)
|
||||
except Exception as exc:
|
||||
logger.error("Could not get json cache key '%s' due to: %s", key, exc)
|
||||
return None
|
||||
|
||||
return None if result is None else _string_to_json(result)
|
||||
|
||||
def get_string(self, key: str) -> str | None:
|
||||
key = self._get_prefixed_key(key)
|
||||
|
||||
try:
|
||||
result: str | None = self.client.get(key, None)
|
||||
|
||||
logger.debug(
|
||||
"Got string cache key '%s'%s",
|
||||
key,
|
||||
"" if result is not None else " (not found)",
|
||||
)
|
||||
|
||||
return result
|
||||
except Exception as exc:
|
||||
logger.error("Could not get string cache key '%s' due to: %s", key, exc)
|
||||
return None
|
||||
|
||||
# TODO Implement binary deserialization
|
||||
def get_object(self, key: str) -> Any | None:
|
||||
raise NotImplementedError()
|
||||
|
||||
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),
|
||||
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, ttl_seconds: Optional[int] = None) -> None:
|
||||
key = self._get_prefixed_key(key)
|
||||
|
||||
try:
|
||||
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, ttl_seconds: Optional[int] = None) -> None:
|
||||
raise NotImplementedError()
|
||||
|
||||
def delete(self, key: str) -> None:
|
||||
key = self._get_prefixed_key(key)
|
||||
|
||||
try:
|
||||
self.client.delete(key)
|
||||
logger.debug("Deleted cache key '%s'", key)
|
||||
except Exception as exc:
|
||||
logger.error("Could not delete cache key '%s' due to: %s", key, exc)
|
110
src/libbot/cache/classes/cache_redis.py
vendored
110
src/libbot/cache/classes/cache_redis.py
vendored
@@ -1,110 +0,0 @@
|
||||
import logging
|
||||
from logging import Logger
|
||||
from typing import Dict, Any, Optional
|
||||
|
||||
from redis import Redis
|
||||
|
||||
from .cache import Cache
|
||||
from ..utils._objects import _json_to_string, _string_to_json
|
||||
|
||||
logger: Logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class CacheRedis(Cache):
|
||||
client: Redis
|
||||
|
||||
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:
|
||||
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)
|
||||
|
||||
def _get_prefixed_key(self, key: str) -> str:
|
||||
return key if self.prefix is None else f"{self.prefix}_{key}"
|
||||
|
||||
def get_json(self, key: str) -> Any | None:
|
||||
key = self._get_prefixed_key(key)
|
||||
|
||||
try:
|
||||
result: Any | None = self.client.get(key)
|
||||
|
||||
logger.debug(
|
||||
"Got json cache key '%s'%s",
|
||||
key,
|
||||
"" if result is not None else " (not found)",
|
||||
)
|
||||
except Exception as exc:
|
||||
logger.error("Could not get json cache key '%s' due to: %s", key, exc)
|
||||
return None
|
||||
|
||||
return None if result is None else _string_to_json(result)
|
||||
|
||||
def get_string(self, key: str) -> str | None:
|
||||
key = self._get_prefixed_key(key)
|
||||
|
||||
try:
|
||||
result: str | None = self.client.get(key)
|
||||
|
||||
logger.debug(
|
||||
"Got string cache key '%s'%s",
|
||||
key,
|
||||
"" if result is not None else " (not found)",
|
||||
)
|
||||
|
||||
return result
|
||||
except Exception as exc:
|
||||
logger.error("Could not get string cache key '%s' due to: %s", key, exc)
|
||||
return None
|
||||
|
||||
# TODO Implement binary deserialization
|
||||
def get_object(self, key: str) -> Any | None:
|
||||
raise NotImplementedError()
|
||||
|
||||
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),
|
||||
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, ttl_seconds: Optional[int] = None) -> None:
|
||||
key = self._get_prefixed_key(key)
|
||||
|
||||
try:
|
||||
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, ttl_seconds: Optional[int] = None) -> None:
|
||||
raise NotImplementedError()
|
||||
|
||||
def delete(self, key: str) -> None:
|
||||
key = self._get_prefixed_key(key)
|
||||
|
||||
try:
|
||||
self.client.delete(key)
|
||||
logger.debug("Deleted cache key '%s'", key)
|
||||
except Exception as exc:
|
||||
logger.error("Could not delete cache key '%s' due to: %s", key, exc)
|
1
src/libbot/cache/manager/__init__.py
vendored
1
src/libbot/cache/manager/__init__.py
vendored
@@ -1 +0,0 @@
|
||||
from .manager import create_cache_client
|
25
src/libbot/cache/manager/manager.py
vendored
25
src/libbot/cache/manager/manager.py
vendored
@@ -1,25 +0,0 @@
|
||||
from typing import Dict, Any, Literal, Optional
|
||||
|
||||
from ..classes import CacheMemcached, CacheRedis
|
||||
|
||||
|
||||
def create_cache_client(
|
||||
config: Dict[str, Any],
|
||||
engine: Literal["memcached", "redis"] | None = None,
|
||||
prefix: Optional[str] = None,
|
||||
) -> CacheMemcached | CacheRedis:
|
||||
if engine not in ["memcached", "redis"] or engine is None:
|
||||
raise KeyError(f"Incorrect cache engine provided. Expected 'memcached' or 'redis', got '{engine}'")
|
||||
|
||||
if "cache" not in config or engine not in config["cache"]:
|
||||
raise KeyError(
|
||||
f"Cache configuration is invalid. Please check if all keys are set (engine: '{engine}')"
|
||||
)
|
||||
|
||||
match engine:
|
||||
case "memcached":
|
||||
return CacheMemcached.from_config(config["cache"][engine], prefix=prefix)
|
||||
case "redis":
|
||||
return CacheRedis.from_config(config["cache"][engine], prefix=prefix)
|
||||
case _:
|
||||
raise KeyError(f"Cache implementation for the engine '{engine}' is not present.")
|
0
src/libbot/cache/utils/__init__.py
vendored
0
src/libbot/cache/utils/__init__.py
vendored
42
src/libbot/cache/utils/_objects.py
vendored
42
src/libbot/cache/utils/_objects.py
vendored
@@ -1,42 +0,0 @@
|
||||
import logging
|
||||
from copy import deepcopy
|
||||
from logging import Logger
|
||||
from typing import Any
|
||||
|
||||
try:
|
||||
from ujson import dumps, loads
|
||||
except ImportError:
|
||||
from json import dumps, loads
|
||||
|
||||
logger: Logger = logging.getLogger(__name__)
|
||||
|
||||
try:
|
||||
from bson import ObjectId
|
||||
except ImportError:
|
||||
logger.warning(
|
||||
"Could not import bson.ObjectId. PyMongo conversions will not be supported by the cache. It's safe to ignore this message if you do not use MongoDB."
|
||||
)
|
||||
|
||||
|
||||
def _json_to_string(json_object: Any) -> str:
|
||||
json_object_copy: Any = deepcopy(json_object)
|
||||
|
||||
if isinstance(json_object_copy, dict) and "_id" in json_object_copy:
|
||||
json_object_copy["_id"] = str(json_object_copy["_id"])
|
||||
|
||||
return dumps(json_object_copy, ensure_ascii=False, indent=0, escape_forward_slashes=False)
|
||||
|
||||
|
||||
def _string_to_json(json_string: str) -> Any:
|
||||
json_object: Any = loads(json_string)
|
||||
|
||||
if "_id" in json_object:
|
||||
try:
|
||||
json_object["_id"] = ObjectId(json_object["_id"])
|
||||
except NameError:
|
||||
logger.debug(
|
||||
"Tried to convert attribute '_id' with value '%s' but bson.ObjectId is not present, skipping the conversion.",
|
||||
json_object["_id"],
|
||||
)
|
||||
|
||||
return json_object
|
@@ -4,8 +4,8 @@ from typing import Any, List, Optional
|
||||
class ConfigKeyError(Exception):
|
||||
"""Raised when config key is not found.
|
||||
|
||||
Args:
|
||||
key (str | List[str]): Missing config key
|
||||
### Attributes:
|
||||
* key (`str | List[str]`): Missing config key.
|
||||
"""
|
||||
|
||||
def __init__(self, key: str | List[str]) -> None:
|
||||
@@ -21,9 +21,9 @@ class ConfigKeyError(Exception):
|
||||
class ConfigValueError(Exception):
|
||||
"""Raised when config key's value is invalid.
|
||||
|
||||
Args:
|
||||
key (str | List[str]): Invalid config key
|
||||
value (Optional[Any]): Key's correct value
|
||||
### Attributes:
|
||||
* key (`str | List[str]`): Invalid config key.
|
||||
* value (`Optional[Any]`): Key's correct value.
|
||||
"""
|
||||
|
||||
def __init__(self, key: str | List[str], value: Optional[Any] = None) -> None:
|
||||
|
@@ -18,16 +18,16 @@ def _(
|
||||
locale: str | None = "en",
|
||||
locales_root: str | Path = Path("locale"),
|
||||
) -> Any:
|
||||
"""Get value of the 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 be 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 the 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 be 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,16 +94,17 @@ 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] = []
|
||||
|
||||
for locale in _get_valid_locales(locales_root):
|
||||
@@ -127,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] = []
|
||||
@@ -160,17 +161,20 @@ async def in_all_locales(key: str, *args: str, locales_root: str | Path = Path("
|
||||
|
||||
|
||||
@asyncable
|
||||
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.
|
||||
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
|
||||
|
||||
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] = {}
|
||||
|
||||
for locale in _get_valid_locales(locales_root):
|
||||
@@ -196,15 +200,15 @@ def in_every_locale(key: str, *args: str, locales_root: str | Path = Path("local
|
||||
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] = {}
|
||||
|
@@ -14,11 +14,6 @@ class BotLocale:
|
||||
default_locale: str | None = "en",
|
||||
locales_root: str | Path = Path("locale"),
|
||||
) -> None:
|
||||
"""
|
||||
Args:
|
||||
default_locale (str | None): Default bot's locale. Defaults to `"en"`
|
||||
locales_root (str | Path): Folder where locales are located. Defaults to `Path("locale")`
|
||||
"""
|
||||
if isinstance(locales_root, str):
|
||||
locales_root = Path(locales_root)
|
||||
elif not isinstance(locales_root, Path):
|
||||
@@ -35,15 +30,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 be 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
|
||||
@@ -69,14 +64,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] = []
|
||||
|
||||
@@ -99,14 +94,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] = {}
|
||||
|
||||
|
@@ -1,13 +1,9 @@
|
||||
import logging
|
||||
from logging import Logger
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict
|
||||
|
||||
from typing_extensions import override
|
||||
|
||||
from ...i18n.classes import BotLocale
|
||||
from ...utils import json_read
|
||||
|
||||
try:
|
||||
from apscheduler.schedulers.asyncio import AsyncIOScheduler
|
||||
from apscheduler.schedulers.background import BackgroundScheduler
|
||||
@@ -15,11 +11,17 @@ try:
|
||||
except ImportError as exc:
|
||||
raise ImportError("You need to install libbot[pycord] in order to use this class.") from exc
|
||||
|
||||
logger: Logger = logging.getLogger(__name__)
|
||||
try:
|
||||
from ujson import loads
|
||||
except ImportError:
|
||||
from json import loads
|
||||
|
||||
from ...i18n.classes import BotLocale
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class PycordBot(Bot):
|
||||
# TODO Write a docstring
|
||||
@override
|
||||
def __init__(
|
||||
self,
|
||||
@@ -30,17 +32,11 @@ class PycordBot(Bot):
|
||||
scheduler: AsyncIOScheduler | BackgroundScheduler | None = None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
|
||||
Args:
|
||||
*args:
|
||||
config:
|
||||
config_path:
|
||||
locales_root:
|
||||
scheduler:
|
||||
**kwargs:
|
||||
"""
|
||||
self.config: Dict[str, Any] = config if config is not None else json_read(config_path)
|
||||
if config is None:
|
||||
with open(config_path, "r", encoding="utf-8") as f:
|
||||
self.config: dict = loads(f.read())
|
||||
else:
|
||||
self.config = config
|
||||
|
||||
super().__init__(
|
||||
debug_guilds=(self.config["bot"]["debug_guilds"] if self.config["debug"] else None),
|
||||
@@ -62,30 +58,15 @@ class PycordBot(Bot):
|
||||
|
||||
self.scheduler: AsyncIOScheduler | BackgroundScheduler | None = scheduler
|
||||
|
||||
# TODO Write a docstring
|
||||
@override
|
||||
async def start(self, token: str, reconnect: bool = True, scheduler_start: bool = True) -> None:
|
||||
"""
|
||||
|
||||
Args:
|
||||
token:
|
||||
reconnect:
|
||||
scheduler_start:
|
||||
"""
|
||||
if self.scheduler is not None and scheduler_start:
|
||||
self.scheduler.start()
|
||||
|
||||
await super().start(token, reconnect=reconnect)
|
||||
|
||||
# TODO Write a docstring
|
||||
@override
|
||||
async def close(self, scheduler_shutdown: bool = True, scheduler_wait: bool = True) -> None:
|
||||
"""
|
||||
|
||||
Args:
|
||||
scheduler_shutdown:
|
||||
scheduler_wait:
|
||||
"""
|
||||
if self.scheduler is not None and scheduler_shutdown:
|
||||
self.scheduler.shutdown(scheduler_wait)
|
||||
|
||||
|
@@ -1 +0,0 @@
|
||||
from .color import color_from_hex, hex_from_color
|
@@ -1,39 +0,0 @@
|
||||
from discord import Colour
|
||||
|
||||
|
||||
def _int_from_hex(hex_string: str) -> int:
|
||||
try:
|
||||
return int(hex_string, base=16)
|
||||
except Exception as exc:
|
||||
raise ValueError("Input string must be a valid HEX code.") from exc
|
||||
|
||||
|
||||
def _hex_from_int(color_int: int) -> str:
|
||||
if not 0 <= color_int <= 0xFFFFFF:
|
||||
raise ValueError("Color's value must be in the range 0 to 0xFFFFFF.")
|
||||
|
||||
return f"#{color_int:06x}"
|
||||
|
||||
|
||||
def color_from_hex(hex_string: str) -> Colour:
|
||||
"""Convert valid hexadecimal string to :class:`discord.Colour`.
|
||||
|
||||
Args:
|
||||
hex_string (str): Hexadecimal string to convert into :class:`discord.Colour` object
|
||||
|
||||
Returns:
|
||||
Colour: :class:`discord.Colour` object
|
||||
"""
|
||||
return Colour(_int_from_hex(hex_string))
|
||||
|
||||
|
||||
def hex_from_color(color: Colour) -> str:
|
||||
"""Convert :class:`discord.Colour` to hexadecimal string.
|
||||
|
||||
Args:
|
||||
color (Colour): :class:`discord.Colour` object to convert into the string
|
||||
|
||||
Returns:
|
||||
str: Hexadecimal string in #XXXXXX format
|
||||
"""
|
||||
return _hex_from_int(color.value)
|
@@ -2,20 +2,13 @@ import asyncio
|
||||
import logging
|
||||
import sys
|
||||
from datetime import datetime, timedelta
|
||||
from logging import Logger
|
||||
from os import cpu_count, getpid
|
||||
from pathlib import Path
|
||||
from time import time
|
||||
from typing import Any, Dict, List, Optional
|
||||
from typing import Any, Dict, List
|
||||
|
||||
from typing_extensions import override
|
||||
|
||||
from .command import PyroCommand
|
||||
from .commandset import CommandSet
|
||||
from ...i18n import _
|
||||
from ...i18n.classes import BotLocale
|
||||
from ...utils import json_read
|
||||
|
||||
try:
|
||||
import pyrogram
|
||||
from apscheduler.schedulers.asyncio import AsyncIOScheduler
|
||||
@@ -42,11 +35,15 @@ try:
|
||||
except ImportError:
|
||||
from json import dumps, loads
|
||||
|
||||
logger: Logger = logging.getLogger(__name__)
|
||||
from ...i18n.classes import BotLocale
|
||||
from ...i18n import _
|
||||
from .command import PyroCommand
|
||||
from .commandset import CommandSet
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class PyroClient(Client):
|
||||
# TODO Write a docstring
|
||||
@override
|
||||
def __init__(
|
||||
self,
|
||||
@@ -69,7 +66,11 @@ class PyroClient(Client):
|
||||
scheduler: AsyncIOScheduler | BackgroundScheduler | None = None,
|
||||
**kwargs,
|
||||
):
|
||||
self.config: Dict[str, Any] = config if config is not None else json_read(config_path)
|
||||
if config is None:
|
||||
with open(config_path, "r", encoding="utf-8") as f:
|
||||
self.config: dict = loads(f.read())
|
||||
else:
|
||||
self.config = config
|
||||
|
||||
super().__init__(
|
||||
name=name,
|
||||
@@ -120,12 +121,6 @@ class PyroClient(Client):
|
||||
|
||||
@override
|
||||
async def start(self, register_commands: bool = True, scheduler_start: bool = True) -> None:
|
||||
"""Start the bot and it's services.
|
||||
|
||||
Args:
|
||||
register_commands (bool, optional): Register commands on start. Defaults to `True`
|
||||
scheduler_start (bool, optional): Start the scheduler on start. Defaults to `True`
|
||||
"""
|
||||
await super().start()
|
||||
|
||||
self.start_time = time()
|
||||
@@ -218,13 +213,6 @@ class PyroClient(Client):
|
||||
async def stop(
|
||||
self, exit_completely: bool = True, scheduler_shutdown: bool = True, scheduler_wait: bool = True
|
||||
) -> None:
|
||||
"""Stop the bot and it's services.
|
||||
|
||||
Args:
|
||||
exit_completely (bool, optional): Exit the program. Defaults to `True`
|
||||
scheduler_shutdown (bool): Shutdown the scheduler. Defaults to `True`
|
||||
scheduler_wait (bool): Wait for tasks to finish. Defaults to `True`
|
||||
"""
|
||||
try:
|
||||
await self.send_message(
|
||||
chat_id=(
|
||||
@@ -251,10 +239,10 @@ class PyroClient(Client):
|
||||
raise SystemExit("Bot has been shut down, this is not an application error!") from exc
|
||||
|
||||
async def collect_commands(self) -> List[CommandSet] | None:
|
||||
"""Gather list of the bot's commands.
|
||||
"""Gather list of the bot's commands
|
||||
|
||||
Returns:
|
||||
List[CommandSet]: List of the commands' sets
|
||||
### Returns:
|
||||
* `List[CommandSet]`: List of the commands' sets.
|
||||
"""
|
||||
command_sets = None
|
||||
|
||||
@@ -336,10 +324,10 @@ class PyroClient(Client):
|
||||
self,
|
||||
command: str,
|
||||
) -> None:
|
||||
"""Add command to the bot's internal commands list.
|
||||
"""Add command to the bot's internal commands list
|
||||
|
||||
Args:
|
||||
command (str): Command's name
|
||||
### Args:
|
||||
* command (`str`)
|
||||
"""
|
||||
self.commands.append(
|
||||
PyroCommand(
|
||||
@@ -352,12 +340,9 @@ class PyroClient(Client):
|
||||
command,
|
||||
)
|
||||
|
||||
async def register_commands(self, command_sets: Optional[List[CommandSet]] = None) -> None:
|
||||
"""Register commands stored in bot's 'commands' attribute.
|
||||
async def register_commands(self, command_sets: List[CommandSet] | None = None) -> None:
|
||||
"""Register commands stored in bot's 'commands' attribute"""
|
||||
|
||||
Args:
|
||||
command_sets (List[CommandSet], optional): List of command sets. Commands will be parsed from bot's 'commands' attribute if not provided
|
||||
"""
|
||||
if command_sets is None:
|
||||
commands = [
|
||||
BotCommand(command=command.command, description=command.description)
|
||||
@@ -382,12 +367,9 @@ class PyroClient(Client):
|
||||
language_code=command_set.language_code,
|
||||
)
|
||||
|
||||
async def remove_commands(self, command_sets: Optional[List[CommandSet]] = None) -> None:
|
||||
"""Remove commands stored in bot's 'commands' attribute.
|
||||
async def remove_commands(self, command_sets: List[CommandSet] | None = None) -> None:
|
||||
"""Remove commands stored in bot's 'commands' attribute"""
|
||||
|
||||
Args:
|
||||
command_sets (List[CommandSet], optional): List of command sets. Commands with scope :class:`pyrogram.types.BotCommandScopeDefault` will be removed if not provided
|
||||
"""
|
||||
if command_sets is None:
|
||||
logger.info("Removing commands with a default scope 'BotCommandScopeDefault'")
|
||||
await self.delete_bot_commands(BotCommandScopeDefault())
|
||||
|
@@ -20,7 +20,7 @@ def config_get(key: str, *path: str, config_file: str | Path = DEFAULT_CONFIG_LO
|
||||
|
||||
### Args:
|
||||
* key (`str`): Key that contains the value
|
||||
* *path (`str`): Path to the key that contains the value (pass *[] or don't pass anything at all to get on the top/root level)
|
||||
* *path (`str`): Path to the key that contains the value
|
||||
* config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
|
||||
|
||||
### Returns:
|
||||
@@ -59,7 +59,7 @@ async def config_get(key: str, *path: str, config_file: str | Path = DEFAULT_CON
|
||||
|
||||
### Args:
|
||||
* key (`str`): Key that contains the value
|
||||
* *path (`str`): Path to the key that contains the value (pass *[] or don't pass anything at all to get on the top/root level)
|
||||
* *path (`str`): Path to the key that contains the value
|
||||
* config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
|
||||
|
||||
### Returns:
|
||||
@@ -98,7 +98,7 @@ def config_set(key: str, value: Any, *path: str, config_file: str | Path = DEFAU
|
||||
### Args:
|
||||
* key (`str`): Key that leads to the value
|
||||
* value (`Any`): Any JSON serializable data
|
||||
* *path (`str`): Path to the key of the target (pass *[] or don't pass anything at all to set on the top/root level)
|
||||
* *path (`str`): Path to the key of the target
|
||||
* config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
|
||||
|
||||
### Raises:
|
||||
@@ -116,7 +116,7 @@ async def config_set(
|
||||
### Args:
|
||||
* key (`str`): Key that leads to the value
|
||||
* value (`Any`): Any JSON serializable data
|
||||
* *path (`str`): Path to the key of the target (pass *[] or don't pass anything at all to set on the top/root level)
|
||||
* *path (`str`): Path to the key of the target
|
||||
* config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
|
||||
|
||||
### Raises:
|
||||
@@ -136,7 +136,7 @@ def config_delete(
|
||||
|
||||
### Args:
|
||||
* key (`str`): Key to delete
|
||||
* *path (`str`): Path to the key of the target (pass *[] or don't pass anything at all to delete on the top/root level)
|
||||
* *path (`str`): Path to the key of the target
|
||||
* missing_ok (`bool`): Do not raise an exception if the key is missing. Defaults to `False`
|
||||
* config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
|
||||
|
||||
@@ -165,7 +165,7 @@ async def config_delete(
|
||||
|
||||
### Args:
|
||||
* key (`str`): Key to delete
|
||||
* *path (`str`): Path to the key of the target (pass *[] or don't pass anything at all to delete on the top/root level)
|
||||
* *path (`str`): Path to the key of the target
|
||||
* missing_ok (`bool`): Do not raise an exception if the key is missing. Defaults to `False`
|
||||
* config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
|
||||
|
||||
|
@@ -3,11 +3,11 @@ from typing import Any, Dict
|
||||
from typing import Callable
|
||||
|
||||
|
||||
def supports_argument(func: Callable[..., Any], arg_name: str) -> bool:
|
||||
def supports_argument(func: Callable, arg_name: str) -> bool:
|
||||
"""Check whether a function has a specific argument
|
||||
|
||||
### Args:
|
||||
* func (`Callable[..., Any]`): Function to be inspected
|
||||
* func (`Callable`): Function to be inspected
|
||||
* arg_name (`str`): Argument to be checked
|
||||
|
||||
### Returns:
|
||||
@@ -24,13 +24,11 @@ def supports_argument(func: Callable[..., Any], arg_name: str) -> bool:
|
||||
return False
|
||||
|
||||
|
||||
def nested_set(
|
||||
target: Dict[str, Any], value: Any, *path: str, create_missing: bool = True
|
||||
) -> Dict[str, Any]:
|
||||
def nested_set(target: dict, value: Any, *path: str, create_missing=True) -> Dict[str, Any]:
|
||||
"""Set the key by its path to the value
|
||||
|
||||
### Args:
|
||||
* target (`Dict[str, Any]`): Dictionary to perform modifications on
|
||||
* target (`dict`): Dictionary to perform modifications on
|
||||
* value (`Any`): Any data
|
||||
* *path (`str`): Path to the key of the target
|
||||
* create_missing (`bool`, *optional*): Create keys on the way if they're missing. Defaults to `True`
|
||||
@@ -41,29 +39,29 @@ def nested_set(
|
||||
### Returns:
|
||||
* `Dict[str, Any]`: Changed dictionary
|
||||
"""
|
||||
target_copy: Dict[str, Any] = target
|
||||
d = target
|
||||
|
||||
for key in path[:-1]:
|
||||
if key in target_copy:
|
||||
target_copy = target_copy[key]
|
||||
if key in d:
|
||||
d = d[key]
|
||||
elif create_missing:
|
||||
target_copy = target_copy.setdefault(key, {})
|
||||
d = d.setdefault(key, {})
|
||||
else:
|
||||
raise KeyError(
|
||||
f"Key '{key}' is not found under path provided ({path}) and create_missing is False"
|
||||
)
|
||||
|
||||
if path[-1] in target_copy or create_missing:
|
||||
target_copy[path[-1]] = value
|
||||
if path[-1] in d or create_missing:
|
||||
d[path[-1]] = value
|
||||
|
||||
return target
|
||||
|
||||
|
||||
def nested_delete(target: Dict[str, Any], *path: str) -> Dict[str, Any]:
|
||||
def nested_delete(target: dict, *path: str) -> Dict[str, Any]:
|
||||
"""Delete the key by its path
|
||||
|
||||
### Args:
|
||||
* target (`Dict[str, Any]`): Dictionary to perform modifications on
|
||||
* target (`dict`): Dictionary to perform modifications on
|
||||
|
||||
### Raises:
|
||||
* `KeyError`: Key is not found under path provided
|
||||
@@ -71,16 +69,16 @@ def nested_delete(target: Dict[str, Any], *path: str) -> Dict[str, Any]:
|
||||
### Returns:
|
||||
`Dict[str, Any]`: Changed dictionary
|
||||
"""
|
||||
target_copy: Dict[str, Any] = target
|
||||
d = target
|
||||
|
||||
for key in path[:-1]:
|
||||
if key in target_copy:
|
||||
target_copy = target_copy[key]
|
||||
if key in d:
|
||||
d = d[key]
|
||||
else:
|
||||
raise KeyError(f"Key '{key}' is not found under path provided ({path})")
|
||||
|
||||
if path[-1] in target_copy:
|
||||
del target_copy[path[-1]]
|
||||
if path[-1] in d:
|
||||
del d[path[-1]]
|
||||
else:
|
||||
raise KeyError(f"Key '{path[-1]}' is not found under path provided ({path})")
|
||||
|
||||
|
@@ -2,14 +2,5 @@
|
||||
"locale": "en",
|
||||
"bot": {
|
||||
"bot_token": "sample_token"
|
||||
},
|
||||
"cache": {
|
||||
"type": "memcached",
|
||||
"memcached": {
|
||||
"uri": "127.0.0.1:11211"
|
||||
},
|
||||
"redis": {
|
||||
"uri": "redis://127.0.0.1:6379/0"
|
||||
}
|
||||
}
|
||||
}
|
@@ -1,28 +0,0 @@
|
||||
from pathlib import Path
|
||||
|
||||
from libbot.cache.classes import Cache
|
||||
from libbot.cache.manager import create_cache_client
|
||||
|
||||
try:
|
||||
from ujson import JSONDecodeError, dumps, loads
|
||||
except ImportError:
|
||||
from json import JSONDecodeError, dumps, loads
|
||||
|
||||
from typing import Any, Dict
|
||||
|
||||
import pytest
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"engine",
|
||||
[
|
||||
"memcached",
|
||||
"redis",
|
||||
],
|
||||
)
|
||||
def test_cache_creation(engine: str, location_config: Path):
|
||||
with open(location_config, "r", encoding="utf-8") as file:
|
||||
config: Dict[str, Any] = loads(file.read())
|
||||
|
||||
cache: Cache = create_cache_client(config, engine)
|
||||
assert isinstance(cache, Cache)
|
5
tox.ini
5
tox.ini
@@ -10,14 +10,13 @@ python =
|
||||
3.13: py313
|
||||
|
||||
[testenv]
|
||||
setenv =
|
||||
setenv =
|
||||
PYTHONPATH = {toxinidir}
|
||||
deps =
|
||||
deps =
|
||||
-r{toxinidir}/requirements/_.txt
|
||||
-r{toxinidir}/requirements/dev.txt
|
||||
-r{toxinidir}/requirements/pycord.txt
|
||||
-r{toxinidir}/requirements/pyrogram.txt
|
||||
-r{toxinidir}/requirements/speed.txt
|
||||
-r{toxinidir}/requirements/cache.txt
|
||||
commands =
|
||||
pytest --basetemp={envtmpdir} --cov=libbot
|
Reference in New Issue
Block a user