Compare commits
267 Commits
v2.1.0
...
2bcc1f94f0
Author | SHA1 | Date | |
---|---|---|---|
2bcc1f94f0
|
|||
f0532f9d39
|
|||
97ac53b597
|
|||
e94baabcfe
|
|||
c3b8eca06f
|
|||
d207c564dc
|
|||
e4807e2999
|
|||
540c94c0ed
|
|||
a10c4a8f51
|
|||
9e40f89d67
|
|||
f5db3cb529
|
|||
eca59e4673
|
|||
923bad856b
|
|||
902ccb5947
|
|||
1fea7ea5f8
|
|||
37928baa6f
|
|||
1f28b1771a
|
|||
5b677f6741
|
|||
883cd50fb3
|
|||
403b52042e
|
|||
5ca813b095
|
|||
b8cd7f2316
|
|||
454c80ad6b
|
|||
1bbab5c154
|
|||
6cb7f9b2f3
|
|||
a4c797079e
|
|||
9a9edbc1a8
|
|||
f991d86d4a
|
|||
cea1b087d3
|
|||
19399fe0ac
|
|||
6da6812d1d
|
|||
ec3dc3a42a
|
|||
01dc9f5d87
|
|||
aa38fc5f0f
|
|||
097581bac7
|
|||
b8bbba66ec
|
|||
ef7380ae45
|
|||
727d531d63
|
|||
7d95b1efee
|
|||
03115b4059
|
|||
e4ce5976f2
|
|||
32a9e14d0c
|
|||
3110bb64b1
|
|||
ad38dbdca1
|
|||
edc3e0717d
|
|||
d70fd4f491
|
|||
c4fb1dd5dd
|
|||
38bf43a5e7
|
|||
5dff5fa71d
|
|||
e596658c68
|
|||
1e1b04a8ff
|
|||
69b034c007
|
|||
|
54de950899 | ||
c17a206c44
|
|||
dc05eb0ccb
|
|||
3a7f748d96
|
|||
95abf4265c
|
|||
84e1cf7ce9
|
|||
accd22dd4d
|
|||
e296aaa6b3
|
|||
6de12244ec | |||
e45266a977 | |||
9f1179f330 | |||
0690a0fe22 | |||
74f5d638e3 | |||
809e103aa3 | |||
6171dac7b8 | |||
b7f847752c | |||
cb5e6c7bdb | |||
762c20a213 | |||
e34cb7f4b1 | |||
7908d0b906 | |||
cc41f4aa83 | |||
f29a6e4896 | |||
2bb62373d6 | |||
0ee1c75031 | |||
12f7cb6365
|
|||
76ee24cd9e
|
|||
6d56d9d0f9
|
|||
554b522400
|
|||
e9abed27f8
|
|||
845a69491d
|
|||
df2b5efd88 | |||
6b2be48052
|
|||
ad70648ea2 | |||
09b4d512a6 | |||
1473d34ca1 | |||
5fc8ae6a6e | |||
8562d7e84c | |||
258b46d829 | |||
efec002667 | |||
475eaf9ff3 | |||
0fcd9f2041 | |||
44d07dc56a | |||
c5e83c17d3 | |||
129cbd923b | |||
1ca126829b
|
|||
974aebfd1a
|
|||
ed7fa50dbd
|
|||
82542de0bb
|
|||
9021eac87b
|
|||
651022ab6e
|
|||
f8c6b782a1
|
|||
a1d0b98858
|
|||
fec40b1c44 | |||
|
e9b9fc6ca1 | ||
1da367ccb1 | |||
|
d5e390fe66 | ||
|
ae54bd5cce | ||
|
9ce251d733 | ||
|
5dd873d683 | ||
b47bcbe513 | |||
|
bbbec75f91 | ||
|
94553b602e | ||
|
3cdd6da506 | ||
|
d24e94b57e | ||
95584c0e63
|
|||
a13ef83e82 | |||
0ce4ddcf7c | |||
aa2c778a6a | |||
a47a508ecf | |||
bdd649bdbe | |||
e6d9beec81 | |||
|
95d04308bd | ||
|
5e479ddc79 | ||
40827e70a1
|
|||
7e03a0c779 | |||
5f4d0b09f9 | |||
f6596d1db6 | |||
cbc4fc36a1 | |||
d20d07bb6a | |||
4ee704b41e | |||
02cfc42f60 | |||
2757bd6b72 | |||
fe71860faa | |||
8fc5a18fab | |||
54d98df7b7 | |||
c9e4b3b916 | |||
acb77049d1 | |||
d41eb742e5 | |||
377ba928ba | |||
b9ae1c2149 | |||
c670521bb2 | |||
c175b4634c | |||
54feb5ff5b | |||
1d32c5e1c3 | |||
eeaa71606b | |||
e130633017 | |||
c71b07695f | |||
03ad8e2144 | |||
c7d0d2793b | |||
41c8a6989b | |||
b8f5d59a4f | |||
67befe6bdb | |||
63cecf7ab8 | |||
6652e8aff7 | |||
a341ffd41d
|
|||
60cc3f22d8 | |||
78a5fb886f | |||
f8ebaff82d | |||
8c15d20dc6 | |||
8587030c23 | |||
b00d4c0281 | |||
dcf5a24d2a | |||
ca989b1e82 | |||
36698b105c | |||
b366bb5c6f | |||
7a67c48ad6 | |||
8b18449e23 | |||
fcb08adc59 | |||
300df5b828 | |||
3d9489eb0e
|
|||
b00e188859 | |||
a5edaa035e | |||
891d8e416b | |||
1e3e6cc7d0 | |||
4c003de0d3 | |||
80fd18d101 | |||
35a85c8cab | |||
8f89d93fdc
|
|||
8dc389d1b3
|
|||
70b5994ecb | |||
ea45ccbad6 | |||
7d287ec46c | |||
d317443960 | |||
4daf6a5a5e | |||
b81700da77 | |||
910efda16c | |||
c91591468b | |||
dad6717706 | |||
263522690f | |||
1bd4b6afe9 | |||
bd3fbd7c2c
|
|||
64ba9efa34
|
|||
15f9274050
|
|||
6d3c20479d
|
|||
dfaadfd769
|
|||
66ede3d60f
|
|||
3c3de1436e
|
|||
cfeadfdd32
|
|||
7032bef956
|
|||
ce691b2eda | |||
a383959c9f | |||
7068e7f194
|
|||
5b16419f20 | |||
2ed348933b
|
|||
c3d3e43216
|
|||
1f464ef624
|
|||
10c7ecbfd0 | |||
e8769e8aeb | |||
f101105d41 | |||
6b44a5852e
|
|||
7af4ad9655
|
|||
cb09910123 | |||
d1da6a1d8b | |||
787fc8c590 | |||
b690725a47 | |||
8719a44720 | |||
2fa65e7c76 | |||
d3502bd935 | |||
de3183d4ed | |||
19f8383fb4 | |||
9e957b7533 | |||
5de6fac3dd | |||
de2524921e | |||
28001f3288 | |||
af82545980 | |||
8308ed0c9d | |||
bf9f19321a | |||
6284d6e631 | |||
63a6542293 | |||
6521a9a510 | |||
1d22188bfc | |||
3a718caacf | |||
06c4b9f845 | |||
00a835442c | |||
4349dcf4d7 | |||
c5c07bd75d | |||
52f2630fda | |||
80e861800c | |||
874892924f | |||
fd113f861b | |||
de7a9ef181 | |||
cde0393baf | |||
70073bf68e | |||
d4ad6609d6 | |||
1e6b2ccaca | |||
abd4f035ad | |||
0408cd676f | |||
b1c61f0a5b | |||
6e7d3c5e6f | |||
458c2ef615 | |||
dc9c83dc68 | |||
48d1d9291a | |||
451b0c5135 | |||
f950eaa339 | |||
bd3c62fed8
|
|||
16658efb17
|
|||
eb0a43e360 | |||
d3a423a560 | |||
20cc754a2a
|
|||
fc14cad3ff
|
|||
327b161b41
|
|||
c756c6b1dc
|
|||
9e9c90fce1
|
|||
91cc03f921 | |||
a0538625e2 |
23
.gitea/workflows/analysis.yml
Normal file
23
.gitea/workflows/analysis.yml
Normal file
@@ -0,0 +1,23 @@
|
||||
name: Analysis
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- dev
|
||||
pull_request:
|
||||
types: [ opened, synchronize, reopened ]
|
||||
|
||||
jobs:
|
||||
sonarcloud:
|
||||
name: SonarCloud
|
||||
runs-on: ubuntu-24.04
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: SonarQube Scan
|
||||
uses: SonarSource/sonarqube-scan-action@v4.2.1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
67
.gitea/workflows/publish.yml
Normal file
67
.gitea/workflows/publish.yml
Normal file
@@ -0,0 +1,67 @@
|
||||
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 }}
|
@@ -10,23 +10,30 @@ on:
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
container: catthehacker/ubuntu:act-latest
|
||||
name: Build and Test
|
||||
runs-on: ubuntu-24.04
|
||||
strategy:
|
||||
matrix:
|
||||
python-version: ["3.8", "3.9", "3.10", "3.11"]
|
||||
|
||||
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
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install tox tox-gh-actions
|
||||
pip install tox tox-gh-actions build
|
||||
- name: Test with tox
|
||||
run: tox
|
||||
- name: Build
|
||||
run: python -m build
|
||||
- uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: Artifacts
|
||||
path: dist/*
|
2
.gitignore
vendored
2
.gitignore
vendored
@@ -166,3 +166,5 @@ venv_linux/
|
||||
venv_windows/
|
||||
|
||||
.vscode/
|
||||
|
||||
tests/.tmp/
|
92
README.md
92
README.md
@@ -1,2 +1,92 @@
|
||||
# LibBotUniversal
|
||||
<h1 align="center">LibBotUniversal</h1>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://git.end-play.xyz/profitroll/LibBotUniversal/src/branch/master/LICENSE"><img alt="PyPI - License" src="https://img.shields.io/pypi/l/libbot">
|
||||
<a href="https://git.end-play.xyz/profitroll/LibBotUniversal/releases/latest"><img alt="Gitea Release" src="https://img.shields.io/gitea/v/release/profitroll/LibBotUniversal?gitea_url=https%3A%2F%2Fgit.end-play.xyz"></a>
|
||||
<a href="https://pypi.org/project/libbot/"><img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/libbot"></a>
|
||||
<a href="https://git.end-play.xyz/profitroll/LibBotUniversal"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
|
||||
</p>
|
||||
|
||||
Handy library for Telegram/Discord bots development.
|
||||
|
||||
## Getting started
|
||||
|
||||
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.
|
||||
|
||||
```shell
|
||||
# Only general features
|
||||
pip install libbot
|
||||
|
||||
# Only with Pyrogram
|
||||
pip install libbot[pyrogram]
|
||||
|
||||
# With Pycord and Performance improvements
|
||||
pip install libbot[pycord,speed]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
### Pyrogram
|
||||
|
||||
```python
|
||||
import sys
|
||||
|
||||
from libbot.pyrogram.classes import PyroClient
|
||||
|
||||
|
||||
def main():
|
||||
client: PyroClient = PyroClient()
|
||||
|
||||
try:
|
||||
client.run()
|
||||
except KeyboardInterrupt:
|
||||
print("Shutting down...")
|
||||
finally:
|
||||
sys.exit()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
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
|
||||
|
||||
|
||||
async def main():
|
||||
intents: Intents = Intents.default()
|
||||
bot: PycordBot = PycordBot(intents=intents)
|
||||
|
||||
bot.load_extension("cogs")
|
||||
|
||||
try:
|
||||
await bot.start(config_get("bot_token", "bot"))
|
||||
except KeyboardInterrupt:
|
||||
print("Shutting down...")
|
||||
await bot.close()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
loop: AbstractEventLoop = asyncio.get_event_loop()
|
||||
loop.run_until_complete(main())
|
||||
```
|
||||
|
||||
## Config examples
|
||||
|
||||
For bot config examples please check the examples directory. Without a valid config file, the bot won't start at all, so
|
||||
you need to make sure the correct config file is used.
|
||||
|
4
examples/README.md
Normal file
4
examples/README.md
Normal file
@@ -0,0 +1,4 @@
|
||||
# Examples
|
||||
|
||||
If you're looking for Pyrogram usage examples, please take a look at
|
||||
the [PyrogramBotBase](https://git.end-play.xyz/profitroll/PyrogramBotBase) repository.
|
21
examples/commands.json
Normal file
21
examples/commands.json
Normal file
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"help": {
|
||||
"scopes": [
|
||||
{
|
||||
"name": "BotCommandScopeDefault"
|
||||
},
|
||||
{
|
||||
"name": "BotCommandScopeChat",
|
||||
"chat_id": "owner"
|
||||
}
|
||||
]
|
||||
},
|
||||
"shutdown": {
|
||||
"scopes": [
|
||||
{
|
||||
"name": "BotCommandScopeChat",
|
||||
"chat_id": "owner"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
13
examples/config_pycord.json
Normal file
13
examples/config_pycord.json
Normal file
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"locale": "en",
|
||||
"debug": false,
|
||||
"bot": {
|
||||
"owners": [
|
||||
0
|
||||
],
|
||||
"debug_guilds": [
|
||||
0
|
||||
],
|
||||
"bot_token": ""
|
||||
}
|
||||
}
|
38
examples/config_pyrogram.json
Normal file
38
examples/config_pyrogram.json
Normal file
@@ -0,0 +1,38 @@
|
||||
{
|
||||
"locale": "en",
|
||||
"bot": {
|
||||
"owner": 0,
|
||||
"api_id": 0,
|
||||
"api_hash": "",
|
||||
"bot_token": "",
|
||||
"workers": 1,
|
||||
"max_concurrent_transmissions": 1,
|
||||
"scoped_commands": true
|
||||
},
|
||||
"reports": {
|
||||
"chat_id": "owner"
|
||||
},
|
||||
"disabled_plugins": [],
|
||||
"commands": {
|
||||
"help": {
|
||||
"scopes": [
|
||||
{
|
||||
"name": "BotCommandScopeDefault"
|
||||
},
|
||||
{
|
||||
"name": "BotCommandScopeChat",
|
||||
"chat_id": "owner"
|
||||
}
|
||||
]
|
||||
},
|
||||
"shutdown": {
|
||||
"scopes": [
|
||||
{
|
||||
"name": "BotCommandScopeChat",
|
||||
"chat_id": "owner"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
23
examples/locale.json
Normal file
23
examples/locale.json
Normal file
@@ -0,0 +1,23 @@
|
||||
{
|
||||
"metadata": {
|
||||
"flag": "🇬🇧",
|
||||
"name": "English",
|
||||
"codes": [
|
||||
"en"
|
||||
]
|
||||
},
|
||||
"bot": {
|
||||
"name": "Your Bot",
|
||||
"about": "I'm a your bot. Nice to meet you!",
|
||||
"description": "I'm just your bot. Yet nice to meet you!"
|
||||
},
|
||||
"commands": {
|
||||
"help": "Show help message"
|
||||
},
|
||||
"messages": {
|
||||
"help": "Sample Text"
|
||||
},
|
||||
"callbacks": {
|
||||
"sample": "This button is working!"
|
||||
}
|
||||
}
|
@@ -1,5 +1,5 @@
|
||||
[build-system]
|
||||
requires = ["setuptools>=62.6", "wheel"]
|
||||
requires = ["setuptools>=77.0.3", "wheel"]
|
||||
build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
@@ -8,17 +8,16 @@ dynamic = ["version", "dependencies", "optional-dependencies"]
|
||||
authors = [{ name = "Profitroll" }]
|
||||
description = "Universal bot library with functions needed for basic Discord/Telegram bot development."
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.8"
|
||||
license = { file = "LICENSE" }
|
||||
requires-python = ">=3.11"
|
||||
license = "GPL-3.0"
|
||||
license-files = ["LICENSE"]
|
||||
classifiers = [
|
||||
"Development Status :: 3 - Alpha",
|
||||
"Intended Audience :: Developers",
|
||||
"License :: OSI Approved :: MIT License",
|
||||
"Operating System :: OS Independent",
|
||||
"Programming Language :: Python :: 3.8",
|
||||
"Programming Language :: Python :: 3.9",
|
||||
"Programming Language :: Python :: 3.10",
|
||||
"Programming Language :: Python :: 3.11",
|
||||
"Programming Language :: Python :: 3.12",
|
||||
"Programming Language :: Python :: 3.13",
|
||||
"Topic :: Software Development :: Libraries :: Python Modules",
|
||||
"Topic :: Utilities",
|
||||
]
|
||||
@@ -32,6 +31,7 @@ dev = { file = "requirements/dev.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"
|
||||
@@ -42,7 +42,8 @@ Tracker = "https://git.end-play.xyz/profitroll/LibBotUniversal/issues"
|
||||
where = ["src"]
|
||||
|
||||
[tool.black]
|
||||
target-version = ['py38', 'py39', 'py310', 'py311']
|
||||
line-length = 108
|
||||
target-version = ["py311", "py312", "py313"]
|
||||
|
||||
[tool.isort]
|
||||
profile = "black"
|
||||
@@ -52,6 +53,8 @@ minversion = "6.0"
|
||||
python_files = ["test_*.py"]
|
||||
pythonpath = "."
|
||||
testpaths = ["tests"]
|
||||
asyncio_mode = "auto"
|
||||
asyncio_default_fixture_loop_scope = "function"
|
||||
|
||||
[tool.mypy]
|
||||
namespace_packages = true
|
||||
@@ -59,9 +62,12 @@ install_types = true
|
||||
strict = true
|
||||
show_error_codes = true
|
||||
|
||||
[tool.pylint]
|
||||
disable = ["line-too-long"]
|
||||
|
||||
[tool.pylint.main]
|
||||
extension-pkg-whitelist = ["ujson"]
|
||||
py-version = 3.8
|
||||
py-version = 3.11
|
||||
|
||||
[tool.coverage.run]
|
||||
source = ["libbot"]
|
||||
|
@@ -1 +1,2 @@
|
||||
aiofiles>=23.0.0
|
||||
typing-extensions~=4.15.0
|
2
requirements/cache.txt
Normal file
2
requirements/cache.txt
Normal file
@@ -0,0 +1,2 @@
|
||||
pymemcache~=4.0.0
|
||||
redis~=6.4.0
|
@@ -1,11 +1,12 @@
|
||||
black==23.12.1
|
||||
build==1.0.3
|
||||
black==25.1.0
|
||||
build==1.3.0
|
||||
isort==5.13.2
|
||||
mypy==1.8.0
|
||||
pylint==3.0.3
|
||||
pytest-asyncio==0.23.2
|
||||
pytest-cov==4.1.0
|
||||
pytest==7.4.3
|
||||
tox==4.11.4
|
||||
types-aiofiles==23.2.0.0
|
||||
types-ujson==5.9.0.0
|
||||
mypy==1.17.1
|
||||
pylint==3.3.8
|
||||
pytest-asyncio==1.1.0
|
||||
pytest-cov==6.2.1
|
||||
pytest==8.4.1
|
||||
tox==4.28.4
|
||||
twine==6.1.0
|
||||
types-aiofiles==24.1.0.20250822
|
||||
types-ujson==5.10.0.20250822
|
@@ -1,2 +1,2 @@
|
||||
apscheduler~=3.10.4
|
||||
py-cord~=2.4.1
|
||||
apscheduler~=3.11.0
|
||||
py-cord~=2.6.0
|
@@ -1,2 +1,2 @@
|
||||
apscheduler~=3.10.4
|
||||
pyrogram~=2.0.106
|
||||
apscheduler~=3.11.0
|
||||
pyrofork~=2.3.32
|
@@ -1 +1 @@
|
||||
ujson~=5.9.0
|
||||
ujson~=5.11.0
|
2
sonar-project.properties
Normal file
2
sonar-project.properties
Normal file
@@ -0,0 +1,2 @@
|
||||
sonar.projectKey=profitroll_libbot
|
||||
sonar.organization=profitroll
|
@@ -1,6 +1,5 @@
|
||||
__version__ = "2.1.0"
|
||||
__version__ = "4.4.0"
|
||||
__license__ = "GPL3"
|
||||
__author__ = "Profitroll"
|
||||
|
||||
from . import i18n, pycord, pyrogram, sync
|
||||
from .__main__ import *
|
||||
from . import utils, errors, i18n, pycord, pyrogram
|
||||
|
@@ -1,95 +0,0 @@
|
||||
from pathlib import Path
|
||||
from typing import Any, Union
|
||||
|
||||
import aiofiles
|
||||
|
||||
try:
|
||||
from ujson import dumps, loads
|
||||
except ImportError:
|
||||
from json import dumps, loads
|
||||
|
||||
from libbot.sync import nested_set
|
||||
|
||||
|
||||
async def json_read(path: Union[str, Path]) -> Any:
|
||||
"""Read contents of a JSON file
|
||||
|
||||
### Args:
|
||||
* path (`Union[str, Path]`): Path-like object or path as a string
|
||||
|
||||
### Returns:
|
||||
* `Any`: File contents
|
||||
"""
|
||||
async with aiofiles.open(str(path), mode="r", encoding="utf-8") as f:
|
||||
data = await f.read()
|
||||
return loads(data)
|
||||
|
||||
|
||||
async def json_write(data: Any, path: Union[str, Path]) -> None:
|
||||
"""Write contents to a JSON file
|
||||
|
||||
### Args:
|
||||
* data (`Any`): Contents to write. Must be a JSON serializable
|
||||
* path (`Union[str, Path]`): Path-like object or path as a string of a destination
|
||||
"""
|
||||
async with aiofiles.open(str(path), mode="w", encoding="utf-8") as f:
|
||||
await f.write(
|
||||
dumps(data, ensure_ascii=False, escape_forward_slashes=False, indent=4)
|
||||
if hasattr(dumps, "escape_forward_slashes")
|
||||
else dumps(data, ensure_ascii=False, indent=4)
|
||||
)
|
||||
|
||||
|
||||
async def config_get(
|
||||
key: str, *path: str, config_file: Union[str, Path] = "config.json"
|
||||
) -> Any:
|
||||
"""Get a value of the config key by its path provided
|
||||
For example, `foo.bar.key` has a path of `"foo", "bar"` and the key `"key"`
|
||||
|
||||
### Args:
|
||||
* key (`str`): Key that contains the value
|
||||
* *path (`str`): Path to the key that contains the value
|
||||
* config_file (`Union[str, Path]`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
|
||||
|
||||
### Returns:
|
||||
* `Any`: Key's value
|
||||
|
||||
### Example:
|
||||
Get the "salary" of "Pete" from this JSON structure:
|
||||
```json
|
||||
{
|
||||
"users": {
|
||||
"Pete": {
|
||||
"salary": 10.0
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
This can be easily done with the following code:
|
||||
```python
|
||||
import libbot
|
||||
salary = await libbot.config_get("salary", "users", "Pete")
|
||||
```
|
||||
"""
|
||||
this_key = await json_read(config_file)
|
||||
for dict_key in path:
|
||||
this_key = this_key[dict_key]
|
||||
return this_key[key]
|
||||
|
||||
|
||||
async def config_set(
|
||||
key: str, value: Any, *path: str, config_file: Union[str, Path] = "config.json"
|
||||
) -> None:
|
||||
"""Set config's key by its path to the value
|
||||
|
||||
### Args:
|
||||
* key (`str`): Key that leads to the value
|
||||
* value (`Any`): Any JSON serializable data
|
||||
* *path (`str`): Path to the key of the target
|
||||
* config_file (`Union[str, Path]`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
|
||||
"""
|
||||
await json_write(
|
||||
nested_set(await json_read(config_file), value, *(*path, key)), config_file
|
||||
)
|
||||
return
|
2
src/libbot/cache/__init__.py
vendored
Normal file
2
src/libbot/cache/__init__.py
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
# 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
Normal file
3
src/libbot/cache/classes/__init__.py
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
from .cache import Cache
|
||||
from .cache_memcached import CacheMemcached
|
||||
from .cache_redis import CacheRedis
|
44
src/libbot/cache/classes/cache.py
vendored
Normal file
44
src/libbot/cache/classes/cache.py
vendored
Normal file
@@ -0,0 +1,44 @@
|
||||
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
Normal file
112
src/libbot/cache/classes/cache_memcached.py
vendored
Normal file
@@ -0,0 +1,112 @@
|
||||
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, 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, 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}"
|
||||
|
||||
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
Normal file
110
src/libbot/cache/classes/cache_redis.py
vendored
Normal file
@@ -0,0 +1,110 @@
|
||||
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, 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, 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}"
|
||||
|
||||
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
Normal file
1
src/libbot/cache/manager/__init__.py
vendored
Normal file
@@ -0,0 +1 @@
|
||||
from .manager import create_cache_client
|
37
src/libbot/cache/manager/manager.py
vendored
Normal file
37
src/libbot/cache/manager/manager.py
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
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,
|
||||
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}'")
|
||||
|
||||
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, default_ttl_seconds=default_ttl_seconds)
|
||||
case "redis":
|
||||
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.")
|
0
src/libbot/cache/utils/__init__.py
vendored
Normal file
0
src/libbot/cache/utils/__init__.py
vendored
Normal file
42
src/libbot/cache/utils/_objects.py
vendored
Normal file
42
src/libbot/cache/utils/_objects.py
vendored
Normal file
@@ -0,0 +1,42 @@
|
||||
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
|
1
src/libbot/errors/__init__.py
Normal file
1
src/libbot/errors/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
from .config import ConfigKeyError, ConfigValueError
|
37
src/libbot/errors/config.py
Normal file
37
src/libbot/errors/config.py
Normal file
@@ -0,0 +1,37 @@
|
||||
from typing import Any, List, Optional
|
||||
|
||||
|
||||
class ConfigKeyError(Exception):
|
||||
"""Raised when config key is not found.
|
||||
|
||||
### Attributes:
|
||||
* key (`str | List[str]`): Missing config key.
|
||||
"""
|
||||
|
||||
def __init__(self, key: str | List[str]) -> None:
|
||||
self.key: str | List[str] = key
|
||||
super().__init__(
|
||||
f"Config key {'.'.join(key) if isinstance(key, list) else key} is missing. Please set in your config file."
|
||||
)
|
||||
|
||||
def __str__(self):
|
||||
return f"Config key {'.'.join(self.key) if isinstance(self.key, list) else self.key} is missing. Please set in your config file."
|
||||
|
||||
|
||||
class ConfigValueError(Exception):
|
||||
"""Raised when config key's value is invalid.
|
||||
|
||||
### 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:
|
||||
self.key: str | List[str] = key
|
||||
self.value: Optional[Any] = value
|
||||
super().__init__(
|
||||
f"Config key {'.'.join(key) if isinstance(key, list) else key} has invalid value. {f'Must be {value}. ' if value else ''}Please set in your config file."
|
||||
)
|
||||
|
||||
def __str__(self):
|
||||
return f"Config key {'.'.join(self.key) if isinstance(self.key, list) else self.key} has invalid value. {f'Must be {self.value}. ' if self.value else ''}Please set in your config file."
|
@@ -1,118 +1,2 @@
|
||||
from os import listdir
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, Union
|
||||
|
||||
import libbot
|
||||
from libbot.i18n import sync
|
||||
from libbot.i18n.classes.bot_locale import BotLocale
|
||||
|
||||
|
||||
async def _(
|
||||
key: str,
|
||||
*args: str,
|
||||
locale: Union[str, None] = "en",
|
||||
locales_root: Union[str, Path] = Path("locale"),
|
||||
) -> Any:
|
||||
"""Get value of locale string
|
||||
|
||||
### Args:
|
||||
* key (`str`): The last key of the locale's keys path.
|
||||
* *args (`list`): Path to key like: `dict[args][key]`.
|
||||
* locale (`Union[str, None]`): Locale to looked up in. Defaults to `"en"`.
|
||||
* locales_root (`Union[str, Path]`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
|
||||
|
||||
### Returns:
|
||||
* `Any`: Value of provided locale key. Is usually `str`, `dict` or `list`
|
||||
"""
|
||||
locale = libbot.sync.config_get("locale") if locale is None else locale
|
||||
|
||||
try:
|
||||
this_dict = await libbot.json_read(Path(f"{locales_root}/{locale}.json"))
|
||||
except FileNotFoundError:
|
||||
try:
|
||||
this_dict = await libbot.json_read(
|
||||
Path(f'{locales_root}/{await libbot.config_get("locale")}.json')
|
||||
)
|
||||
except FileNotFoundError:
|
||||
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
||||
|
||||
this_key = this_dict
|
||||
for dict_key in args:
|
||||
this_key = this_key[dict_key]
|
||||
|
||||
try:
|
||||
return this_key[key]
|
||||
except KeyError:
|
||||
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
||||
|
||||
|
||||
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
|
||||
|
||||
### Args:
|
||||
* key (`str`): The last key of the locale's keys path.
|
||||
* *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:
|
||||
* `list`: List of values in all locales
|
||||
"""
|
||||
|
||||
output = []
|
||||
files_locales = listdir(locales_root)
|
||||
|
||||
valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
|
||||
for lc in valid_locales:
|
||||
try:
|
||||
this_dict = await libbot.json_read(Path(f"{locales_root}/{lc}.json"))
|
||||
except FileNotFoundError:
|
||||
continue
|
||||
|
||||
this_key = this_dict
|
||||
for dict_key in args:
|
||||
this_key = this_key[dict_key]
|
||||
|
||||
try:
|
||||
output.append(this_key[key])
|
||||
except KeyError:
|
||||
continue
|
||||
|
||||
return output
|
||||
|
||||
|
||||
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
|
||||
|
||||
### Args:
|
||||
* key (`str`): The last key of the locale's keys path.
|
||||
* *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:
|
||||
* `Dict[str, Any]`: Locale is a key and it's value from locale file is a value
|
||||
"""
|
||||
|
||||
output = {}
|
||||
files_locales = listdir(locales_root)
|
||||
|
||||
valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
|
||||
for lc in valid_locales:
|
||||
try:
|
||||
this_dict = await libbot.json_read(Path(f"{locales_root}/{lc}.json"))
|
||||
except FileNotFoundError:
|
||||
continue
|
||||
|
||||
this_key = this_dict
|
||||
for dict_key in args:
|
||||
this_key = this_key[dict_key]
|
||||
|
||||
try:
|
||||
output[lc] = this_key[key]
|
||||
except KeyError:
|
||||
continue
|
||||
|
||||
return output
|
||||
from ._functions import _, in_all_locales, in_every_locale
|
||||
from .classes import BotLocale
|
||||
|
232
src/libbot/i18n/_functions.py
Normal file
232
src/libbot/i18n/_functions.py
Normal file
@@ -0,0 +1,232 @@
|
||||
from os import listdir, PathLike
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, List
|
||||
|
||||
from ..utils.config import config_get
|
||||
from ..utils.json import json_read
|
||||
from ..utils.syncs import asyncable
|
||||
|
||||
|
||||
def _get_valid_locales(locales_root: str | PathLike[str]) -> List[str]:
|
||||
return [".".join(entry.split(".")[:-1]) for entry in listdir(locales_root)]
|
||||
|
||||
|
||||
@asyncable
|
||||
def _(
|
||||
key: str,
|
||||
*args: str,
|
||||
locale: str | None = "en",
|
||||
locales_root: str | Path = Path("locale"),
|
||||
) -> Any:
|
||||
"""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").
|
||||
|
||||
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")
|
||||
|
||||
try:
|
||||
this_dict: Dict[str, Any] = json_read(Path(f"{locales_root}/{locale}.json"))
|
||||
except FileNotFoundError:
|
||||
try:
|
||||
this_dict: Dict[str, Any] = json_read(Path(f'{locales_root}/{config_get("locale")}.json'))
|
||||
except FileNotFoundError:
|
||||
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
||||
|
||||
this_key: Dict[str, Any] = this_dict
|
||||
|
||||
for dict_key in args:
|
||||
this_key = this_key[dict_key]
|
||||
|
||||
try:
|
||||
return this_key[key]
|
||||
except KeyError:
|
||||
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
||||
|
||||
|
||||
@_.asynchronous
|
||||
async def _(
|
||||
key: str,
|
||||
*args: str,
|
||||
locale: str | None = "en",
|
||||
locales_root: str | Path = Path("locale"),
|
||||
) -> Any:
|
||||
"""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").
|
||||
|
||||
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
|
||||
|
||||
try:
|
||||
this_dict: Dict[str, Any] = await json_read(Path(f"{locales_root}/{locale}.json"))
|
||||
except FileNotFoundError:
|
||||
try:
|
||||
this_dict: Dict[str, Any] = await json_read(
|
||||
Path(f'{locales_root}/{await config_get("locale")}.json')
|
||||
)
|
||||
except FileNotFoundError:
|
||||
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
||||
|
||||
this_key: Dict[str, Any] = this_dict
|
||||
|
||||
for dict_key in args:
|
||||
this_key = this_key[dict_key]
|
||||
|
||||
try:
|
||||
return this_key[key]
|
||||
except KeyError:
|
||||
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
||||
|
||||
|
||||
@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.
|
||||
|
||||
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.
|
||||
"""
|
||||
|
||||
output: List[Any] = []
|
||||
|
||||
for locale in _get_valid_locales(locales_root):
|
||||
try:
|
||||
this_dict: Dict[str, Any] = json_read(Path(f"{locales_root}/{locale}.json"))
|
||||
except FileNotFoundError:
|
||||
continue
|
||||
|
||||
this_key: Dict[str, Any] = this_dict
|
||||
|
||||
for dict_key in args:
|
||||
this_key = this_key[dict_key]
|
||||
|
||||
try:
|
||||
output.append(this_key[key])
|
||||
except KeyError:
|
||||
continue
|
||||
|
||||
return output
|
||||
|
||||
|
||||
@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.
|
||||
|
||||
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.
|
||||
"""
|
||||
|
||||
output: List[Any] = []
|
||||
|
||||
for locale in _get_valid_locales(locales_root):
|
||||
try:
|
||||
this_dict: Dict[str, Any] = await json_read(Path(f"{locales_root}/{locale}.json"))
|
||||
except FileNotFoundError:
|
||||
continue
|
||||
|
||||
this_key: Dict[str, Any] = this_dict
|
||||
|
||||
for dict_key in args:
|
||||
this_key = this_key[dict_key]
|
||||
|
||||
try:
|
||||
output.append(this_key[key])
|
||||
except KeyError:
|
||||
continue
|
||||
|
||||
return output
|
||||
|
||||
|
||||
@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.
|
||||
|
||||
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.
|
||||
"""
|
||||
|
||||
output: Dict[str, Any] = {}
|
||||
|
||||
for locale in _get_valid_locales(locales_root):
|
||||
try:
|
||||
this_dict: Dict[str, Any] = json_read(Path(f"{locales_root}/{locale}.json"))
|
||||
except FileNotFoundError:
|
||||
continue
|
||||
|
||||
this_key: Dict[str, Any] = this_dict
|
||||
|
||||
for dict_key in args:
|
||||
this_key = this_key[dict_key]
|
||||
|
||||
try:
|
||||
output[locale] = this_key[key]
|
||||
except KeyError:
|
||||
continue
|
||||
|
||||
return output
|
||||
|
||||
|
||||
@in_every_locale.asynchronous
|
||||
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.
|
||||
|
||||
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.
|
||||
"""
|
||||
|
||||
output: Dict[str, Any] = {}
|
||||
|
||||
for locale in _get_valid_locales(locales_root):
|
||||
try:
|
||||
this_dict: Dict[str, Any] = await json_read(Path(f"{locales_root}/{locale}.json"))
|
||||
except FileNotFoundError:
|
||||
continue
|
||||
|
||||
this_key: Dict[str, Any] = this_dict
|
||||
|
||||
for dict_key in args:
|
||||
this_key = this_key[dict_key]
|
||||
|
||||
try:
|
||||
output[locale] = this_key[key]
|
||||
except KeyError:
|
||||
continue
|
||||
|
||||
return output
|
1
src/libbot/i18n/classes/__init__.py
Normal file
1
src/libbot/i18n/classes/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
from .bot_locale import BotLocale
|
@@ -1,8 +1,9 @@
|
||||
from os import listdir
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, Union
|
||||
from typing import Any, Dict, List
|
||||
|
||||
from libbot import sync
|
||||
from ...utils.config import config_get
|
||||
from ...utils.json import json_read
|
||||
|
||||
|
||||
class BotLocale:
|
||||
@@ -10,52 +11,55 @@ class BotLocale:
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
default_locale: Union[str, None] = "en",
|
||||
locales_root: Union[str, Path] = Path("locale"),
|
||||
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):
|
||||
raise TypeError("'locales_root' must be a valid path or path-like object")
|
||||
|
||||
files_locales: list = listdir(locales_root)
|
||||
files_locales: List[str] = listdir(locales_root)
|
||||
|
||||
valid_locales: list = [
|
||||
".".join(entry.split(".")[:-1]) for entry in files_locales
|
||||
]
|
||||
valid_locales: List[str] = [".".join(entry.split(".")[:-1]) for entry in files_locales]
|
||||
|
||||
self.default: str = (
|
||||
sync.config_get("locale") if default_locale is None else default_locale
|
||||
)
|
||||
self.locales: dict = {}
|
||||
self.default: str = config_get("locale") if default_locale is None else default_locale
|
||||
self.locales: Dict[str, Any] = {}
|
||||
|
||||
for lc in valid_locales:
|
||||
self.locales[lc] = sync.json_read(Path(f"{locales_root}/{lc}.json"))
|
||||
for locale in valid_locales:
|
||||
self.locales[locale] = json_read(Path(f"{locales_root}/{locale}.json"))
|
||||
|
||||
def _(self, key: str, *args: str, locale: Union[str, None] = None) -> Any:
|
||||
"""Get value of locale string
|
||||
def _(self, key: str, *args: str, locale: str | None = None) -> Any:
|
||||
"""Get value of locale string.
|
||||
|
||||
### Args:
|
||||
* key (`str`): The last key of the locale's keys path
|
||||
* *args (`list`): Path to key like: `dict[args][key]`
|
||||
* locale (`Union[str, None]`, *optional*): Locale to looked up in. Defaults to config's `"locale"` value
|
||||
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` or `list`
|
||||
Returns:
|
||||
Any: Value of provided locale key. Is usually `str`, `Dict[str, Any]` or `List[Any]`.
|
||||
"""
|
||||
|
||||
if locale is None:
|
||||
locale = self.default
|
||||
locale: str = self.default
|
||||
|
||||
try:
|
||||
this_dict = self.locales[locale]
|
||||
this_dict: Dict[str, Any] = self.locales[locale]
|
||||
except KeyError:
|
||||
try:
|
||||
this_dict = self.locales[self.default]
|
||||
this_dict: Dict[str, Any] = self.locales[self.default]
|
||||
except KeyError:
|
||||
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}"'
|
||||
)
|
||||
|
||||
this_key: Dict[str, Any] = this_dict
|
||||
|
||||
this_key = this_dict
|
||||
for dict_key in args:
|
||||
this_key = this_key[dict_key]
|
||||
|
||||
@@ -64,26 +68,26 @@ class BotLocale:
|
||||
except KeyError:
|
||||
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
||||
|
||||
def in_all_locales(self, key: str, *args: str) -> list:
|
||||
"""Get value of the provided key and path in all available locales
|
||||
def in_all_locales(self, key: str, *args: str) -> List[Any]:
|
||||
"""Get value of the provided key and path in all available locales.
|
||||
|
||||
### Args:
|
||||
* key (`str`): The last key of the locale's keys path.
|
||||
* *args (`list`): Path to key like: `dict[args][key]`.
|
||||
Args:
|
||||
key (str): The last key of the locale's keys path.
|
||||
*args (str): Path to key like: `dict[args][key]`.
|
||||
|
||||
### Returns:
|
||||
* `list`: List of values in all locales
|
||||
Returns:
|
||||
List[Any]: List of values in all locales.
|
||||
"""
|
||||
output: List[Any] = []
|
||||
|
||||
output = []
|
||||
|
||||
for name, lc in self.locales.items():
|
||||
for name, locale in self.locales.items():
|
||||
try:
|
||||
this_dict = lc
|
||||
this_dict: Dict[str, Any] = locale
|
||||
except KeyError:
|
||||
continue
|
||||
|
||||
this_key = this_dict
|
||||
this_key: Dict[str, Any] = this_dict
|
||||
|
||||
for dict_key in args:
|
||||
this_key = this_key[dict_key]
|
||||
|
||||
@@ -95,25 +99,25 @@ 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 (`list`): 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] = {}
|
||||
|
||||
output = {}
|
||||
|
||||
for name, lc in self.locales.items():
|
||||
for name, locale in self.locales.items():
|
||||
try:
|
||||
this_dict = lc
|
||||
this_dict: Dict[str, Any] = locale
|
||||
except KeyError:
|
||||
continue
|
||||
|
||||
this_key = this_dict
|
||||
this_key: Dict[str, Any] = this_dict
|
||||
|
||||
for dict_key in args:
|
||||
this_key = this_key[dict_key]
|
||||
|
||||
|
@@ -1,117 +0,0 @@
|
||||
from os import listdir
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, Union
|
||||
|
||||
import libbot
|
||||
|
||||
|
||||
def _(
|
||||
key: str,
|
||||
*args: str,
|
||||
locale: Union[str, None] = "en",
|
||||
locales_root: Union[str, Path] = Path("locale"),
|
||||
) -> Any:
|
||||
"""Get value of locale string
|
||||
|
||||
### Args:
|
||||
* key (`str`): The last key of the locale's keys path.
|
||||
* *args (`list`): Path to key like: `dict[args][key]`.
|
||||
* locale (`Union[str, None]`): Locale to looked up in. Defaults to `"en"`.
|
||||
* locales_root (`Union[str, Path]`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
|
||||
|
||||
### Returns:
|
||||
* `Any`: Value of provided locale key. Is usually `str`, `dict` or `list`
|
||||
"""
|
||||
if locale is None:
|
||||
locale = libbot.sync.config_get("locale")
|
||||
|
||||
try:
|
||||
this_dict = libbot.sync.json_read(Path(f"{locales_root}/{locale}.json"))
|
||||
except FileNotFoundError:
|
||||
try:
|
||||
this_dict = libbot.sync.json_read(
|
||||
Path(f'{locales_root}/{libbot.sync.config_get("locale")}.json')
|
||||
)
|
||||
except FileNotFoundError:
|
||||
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
||||
|
||||
this_key = this_dict
|
||||
for dict_key in args:
|
||||
this_key = this_key[dict_key]
|
||||
|
||||
try:
|
||||
return this_key[key]
|
||||
except KeyError:
|
||||
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
||||
|
||||
|
||||
def in_all_locales(
|
||||
key: str, *args: str, locales_root: Union[str, Path] = Path("locale")
|
||||
) -> list:
|
||||
"""Get value of the provided key and path in all available locales
|
||||
|
||||
### Args:
|
||||
* key (`str`): The last key of the locale's keys path.
|
||||
* *args (`list`): Path to key like: `dict[args][key]`.
|
||||
* locales_root (`Union[str, Path]`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
|
||||
|
||||
### Returns:
|
||||
* `list`: List of values in all locales
|
||||
"""
|
||||
|
||||
output = []
|
||||
files_locales = listdir(locales_root)
|
||||
|
||||
valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
|
||||
for lc in valid_locales:
|
||||
try:
|
||||
this_dict = libbot.sync.json_read(Path(f"{locales_root}/{lc}.json"))
|
||||
except FileNotFoundError:
|
||||
continue
|
||||
|
||||
this_key = this_dict
|
||||
for dict_key in args:
|
||||
this_key = this_key[dict_key]
|
||||
|
||||
try:
|
||||
output.append(this_key[key])
|
||||
except KeyError:
|
||||
continue
|
||||
|
||||
return output
|
||||
|
||||
|
||||
def in_every_locale(
|
||||
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
|
||||
|
||||
### Args:
|
||||
* key (`str`): The last key of the locale's keys path.
|
||||
* *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:
|
||||
* `Dict[str, Any]`: Locale is a key and it's value from locale file is a value
|
||||
"""
|
||||
|
||||
output = {}
|
||||
files_locales = listdir(locales_root)
|
||||
|
||||
valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
|
||||
for lc in valid_locales:
|
||||
try:
|
||||
this_dict = libbot.sync.json_read(Path(f"{locales_root}/{lc}.json"))
|
||||
except FileNotFoundError:
|
||||
continue
|
||||
|
||||
this_key = this_dict
|
||||
for dict_key in args:
|
||||
this_key = this_key[dict_key]
|
||||
|
||||
try:
|
||||
output[lc] = this_key[key]
|
||||
except KeyError:
|
||||
continue
|
||||
|
||||
return output
|
2
src/libbot/pycord/__init__.py
Normal file
2
src/libbot/pycord/__init__.py
Normal file
@@ -0,0 +1,2 @@
|
||||
# This file is left empty on purpose
|
||||
# Adding imports here will cause import errors when libbot[pycord] is not installed
|
@@ -1,45 +1,40 @@
|
||||
import logging
|
||||
from logging import Logger
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, Union
|
||||
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
|
||||
from discord import Bot
|
||||
except ImportError as exc:
|
||||
raise ImportError(
|
||||
"You need to install libbot[pycord] in order to use this class."
|
||||
) from exc
|
||||
raise ImportError("You need to install libbot[pycord] in order to use this class.") from exc
|
||||
|
||||
try:
|
||||
from ujson import loads
|
||||
except ImportError:
|
||||
from json import loads
|
||||
|
||||
from libbot.i18n import BotLocale
|
||||
from libbot.i18n.sync import _
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
logger: Logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class PycordBot(Bot):
|
||||
@override
|
||||
def __init__(
|
||||
self,
|
||||
config: Union[Dict[str, Any], None] = None,
|
||||
config_path: Union[str, Path] = Path("config.json"),
|
||||
locales_root: Union[str, Path, None] = None,
|
||||
scheduler: Union[AsyncIOScheduler, BackgroundScheduler, None] = None,
|
||||
*args,
|
||||
config: Dict[str, Any] | None = None,
|
||||
config_path: str | Path = Path("config.json"),
|
||||
locales_root: str | Path | None = None,
|
||||
scheduler: AsyncIOScheduler | BackgroundScheduler | None = None,
|
||||
**kwargs,
|
||||
):
|
||||
if config is None:
|
||||
with open(config_path, "r", encoding="utf-8") as f:
|
||||
self.config: dict = loads(f.read())
|
||||
else:
|
||||
self.config = config
|
||||
self.config: Dict[str, Any] = config if config is not None else json_read(config_path)
|
||||
|
||||
super().__init__(
|
||||
debug_guilds=self.config["bot"]["debug_guilds"],
|
||||
debug_guilds=(self.config["bot"]["debug_guilds"] if self.config["debug"] else None),
|
||||
owner_ids=self.config["bot"]["owners"],
|
||||
*args,
|
||||
**kwargs,
|
||||
)
|
||||
|
||||
@@ -48,10 +43,24 @@ class PycordBot(Bot):
|
||||
locales_root=(Path("locale") if locales_root is None else locales_root),
|
||||
)
|
||||
self.default_locale: str = self.bot_locale.default
|
||||
self.locales: dict = self.bot_locale.locales
|
||||
self.locales: Dict[str, Any] = self.bot_locale.locales
|
||||
|
||||
self._ = self.bot_locale._
|
||||
self.in_all_locales = self.bot_locale.in_all_locales
|
||||
self.in_every_locale = self.bot_locale.in_every_locale
|
||||
|
||||
self.scheduler: Union[AsyncIOScheduler, BackgroundScheduler, None] = scheduler
|
||||
self.scheduler: AsyncIOScheduler | BackgroundScheduler | None = scheduler
|
||||
|
||||
@override
|
||||
async def start(self, token: str, reconnect: bool = True, scheduler_start: bool = True) -> None:
|
||||
if self.scheduler is not None and scheduler_start:
|
||||
self.scheduler.start()
|
||||
|
||||
await super().start(token, reconnect=reconnect)
|
||||
|
||||
@override
|
||||
async def close(self, scheduler_shutdown: bool = True, scheduler_wait: bool = True) -> None:
|
||||
if self.scheduler is not None and scheduler_shutdown:
|
||||
self.scheduler.shutdown(scheduler_wait)
|
||||
|
||||
await super().close()
|
||||
|
1
src/libbot/pycord/utils/__init__.py
Normal file
1
src/libbot/pycord/utils/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
from .color import color_from_hex, hex_from_color
|
35
src/libbot/pycord/utils/color.py
Normal file
35
src/libbot/pycord/utils/color.py
Normal file
@@ -0,0 +1,35 @@
|
||||
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 discord.Colour.
|
||||
|
||||
:param hex_string: Hexadecimal string to convert into Colour object
|
||||
:type hex_string: str
|
||||
:return: Colour object
|
||||
"""
|
||||
return Colour(_int_from_hex(hex_string))
|
||||
|
||||
|
||||
def hex_from_color(color: Colour) -> str:
|
||||
"""Convert discord.Colour to hexadecimal string.
|
||||
|
||||
:param color: Colour object to convert into the string
|
||||
:type color: Colour
|
||||
:return: Hexadecimal string in #XXXXXX format
|
||||
"""
|
||||
return _hex_from_int(color.value)
|
2
src/libbot/pyrogram/__init__.py
Normal file
2
src/libbot/pyrogram/__init__.py
Normal file
@@ -0,0 +1,2 @@
|
||||
# This file is left empty on purpose
|
||||
# Adding imports here will cause import errors when libbot[pyrogram] is not installed
|
@@ -1,10 +1,20 @@
|
||||
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, Union
|
||||
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
|
||||
@@ -25,85 +35,74 @@ try:
|
||||
BotCommandScopeDefault,
|
||||
)
|
||||
except ImportError as exc:
|
||||
raise ImportError(
|
||||
"You need to install libbot[pyrogram] in order to use this class."
|
||||
) from exc
|
||||
raise ImportError("You need to install libbot[pyrogram] in order to use this class.") from exc
|
||||
|
||||
try:
|
||||
from ujson import dumps, loads
|
||||
except ImportError:
|
||||
from json import dumps, loads
|
||||
|
||||
from libbot.i18n import BotLocale
|
||||
from libbot.i18n.sync import _
|
||||
from libbot.pyrogram.classes.command import PyroCommand
|
||||
from libbot.pyrogram.classes.commandset import CommandSet
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
logger: Logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class PyroClient(Client):
|
||||
@override
|
||||
def __init__(
|
||||
self,
|
||||
name: str = "bot_client",
|
||||
config: Union[Dict[str, Any], None] = None,
|
||||
config_path: Union[str, Path] = Path("config.json"),
|
||||
api_id: Union[int, None] = None,
|
||||
api_hash: Union[str, None] = None,
|
||||
bot_token: Union[str, None] = None,
|
||||
owner: int | None = None,
|
||||
config: Dict[str, Any] | None = None,
|
||||
config_path: str | Path = Path("config.json"),
|
||||
api_id: int | None = None,
|
||||
api_hash: str | None = None,
|
||||
bot_token: str | None = None,
|
||||
workers: int = min(32, cpu_count() + 4),
|
||||
locales_root: Union[str, Path, None] = None,
|
||||
locales_root: str | Path | None = None,
|
||||
plugins_root: str = "plugins",
|
||||
plugins_exclude: Union[List[str], None] = None,
|
||||
plugins_exclude: List[str] | None = None,
|
||||
sleep_threshold: int = 120,
|
||||
max_concurrent_transmissions: int = 1,
|
||||
commands_source: Union[Dict[str, dict], None] = None,
|
||||
scheduler: Union[AsyncIOScheduler, BackgroundScheduler, None] = None,
|
||||
commands_source: Dict[str, dict] | None = None,
|
||||
scoped_commands: bool | None = None,
|
||||
i18n_bot_info: bool = False,
|
||||
scheduler: AsyncIOScheduler | BackgroundScheduler | None = None,
|
||||
**kwargs,
|
||||
):
|
||||
if config is None:
|
||||
with open(config_path, "r", encoding="utf-8") as f:
|
||||
self.config: dict = loads(f.read())
|
||||
else:
|
||||
self.config = config
|
||||
self.config: Dict[str, Any] = config if config is not None else json_read(config_path)
|
||||
|
||||
super().__init__(
|
||||
name=name,
|
||||
api_id=self.config["bot"]["api_id"] if api_id is None else api_id,
|
||||
api_hash=self.config["bot"]["api_hash"] if api_hash is None else api_hash,
|
||||
bot_token=self.config["bot"]["bot_token"]
|
||||
if bot_token is None
|
||||
else bot_token,
|
||||
bot_token=self.config["bot"]["bot_token"] if bot_token is None else bot_token,
|
||||
# Workers should be `min(32, cpu_count() + 4)`, otherwise
|
||||
# handlers land in another event loop and you won't see them
|
||||
workers=self.config["bot"]["workers"]
|
||||
if "workers" in self.config["bot"]
|
||||
else workers,
|
||||
workers=self.config["bot"]["workers"] if "workers" in self.config["bot"] else workers,
|
||||
plugins=dict(
|
||||
root=plugins_root,
|
||||
exclude=self.config["disabled_plugins"]
|
||||
if plugins_exclude is None
|
||||
else plugins_exclude,
|
||||
exclude=self.config["disabled_plugins"] if plugins_exclude is None else plugins_exclude,
|
||||
),
|
||||
sleep_threshold=sleep_threshold,
|
||||
max_concurrent_transmissions=self.config["bot"][
|
||||
"max_concurrent_transmissions"
|
||||
]
|
||||
max_concurrent_transmissions=(
|
||||
self.config["bot"]["max_concurrent_transmissions"]
|
||||
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"] if owner is None else owner
|
||||
self.commands: List[PyroCommand] = []
|
||||
self.commands_source: Dict[str, dict] = (
|
||||
self.config["commands"] if commands_source is None else commands_source
|
||||
)
|
||||
self.scoped_commands: bool = self.config["bot"]["scoped_commands"]
|
||||
self.scoped_commands: bool = (
|
||||
self.config["bot"]["scoped_commands"] if scoped_commands is None else scoped_commands
|
||||
)
|
||||
self.start_time: float = 0
|
||||
|
||||
self.bot_locale: BotLocale = BotLocale(
|
||||
default_locale=self.config["locale"],
|
||||
locales_root=(Path("locale") if locales_root is None else locales_root)
|
||||
locales_root=(Path("locale") if locales_root is None else locales_root),
|
||||
)
|
||||
self.default_locale: str = self.bot_locale.default
|
||||
self.locales: dict = self.bot_locale.locales
|
||||
@@ -112,11 +111,14 @@ class PyroClient(Client):
|
||||
self.in_all_locales = self.bot_locale.in_all_locales
|
||||
self.in_every_locale = self.bot_locale.in_every_locale
|
||||
|
||||
self.scheduler: Union[AsyncIOScheduler, BackgroundScheduler, None] = scheduler
|
||||
self.scheduler: AsyncIOScheduler | BackgroundScheduler | None = scheduler
|
||||
|
||||
self.scopes_placeholders: Dict[str, int] = {"owner": self.owner}
|
||||
|
||||
async def start(self, register_commands: bool = True) -> None:
|
||||
self.i18n_bot_info: bool = i18n_bot_info
|
||||
|
||||
@override
|
||||
async def start(self, register_commands: bool = True, scheduler_start: bool = True) -> None:
|
||||
await super().start()
|
||||
|
||||
self.start_time = time()
|
||||
@@ -129,17 +131,71 @@ class PyroClient(Client):
|
||||
getpid(),
|
||||
)
|
||||
|
||||
if self.i18n_bot_info:
|
||||
# Register default bot's info
|
||||
try:
|
||||
await self.set_bot_info(
|
||||
name=self._("name", "bot"),
|
||||
about=self._("about", "bot"),
|
||||
description=self._("description", "bot"),
|
||||
lang_code="",
|
||||
)
|
||||
logger.info(
|
||||
"Bot's info for the default locale %s has been updated",
|
||||
self.default_locale,
|
||||
)
|
||||
except KeyError:
|
||||
logger.warning(
|
||||
"Default locale %s has incorrect keys or values in bot section",
|
||||
self.default_locale,
|
||||
)
|
||||
|
||||
# Register bot's info for each available locale
|
||||
for locale_code in self.locales:
|
||||
locale = self.locales[locale_code]
|
||||
|
||||
if "metadata" not in locale or ("codes" not in locale["metadata"]):
|
||||
logger.warning(
|
||||
"Locale %s is missing metadata or metadata.codes key",
|
||||
locale_code,
|
||||
)
|
||||
continue
|
||||
|
||||
for code in locale["metadata"]["codes"]:
|
||||
try:
|
||||
await self.set_bot_info(
|
||||
name=locale["bot"]["name"],
|
||||
about=locale["bot"]["about"],
|
||||
description=locale["bot"]["description"],
|
||||
lang_code=code,
|
||||
)
|
||||
logger.info(
|
||||
"Bot's info for the locale %s has been updated",
|
||||
code,
|
||||
)
|
||||
except KeyError:
|
||||
logger.warning(
|
||||
"Locale %s has incorrect keys or values in bot section",
|
||||
locale_code,
|
||||
)
|
||||
|
||||
# Send a message to the bot's reports chat about the startup
|
||||
try:
|
||||
await self.send_message(
|
||||
chat_id=self.owner
|
||||
chat_id=(
|
||||
self.owner
|
||||
if self.config["reports"]["chat_id"] == "owner"
|
||||
else self.config["reports"]["chat_id"],
|
||||
else self.config["reports"]["chat_id"]
|
||||
),
|
||||
text=f"Bot started PID `{getpid()}`",
|
||||
)
|
||||
except BadRequest:
|
||||
logger.warning("Unable to send message to report chat.")
|
||||
|
||||
if self.scheduler is None:
|
||||
return
|
||||
|
||||
# Schedule the task to register all commands
|
||||
if register_commands:
|
||||
self.scheduler.add_job(
|
||||
self.register_commands,
|
||||
@@ -148,38 +204,43 @@ class PyroClient(Client):
|
||||
kwargs={"command_sets": await self.collect_commands()},
|
||||
)
|
||||
|
||||
if scheduler_start:
|
||||
self.scheduler.start()
|
||||
except BadRequest:
|
||||
logger.warning("Unable to send message to report chat.")
|
||||
|
||||
async def stop(self, exit_completely: bool = True) -> None:
|
||||
@override
|
||||
async def stop(
|
||||
self, exit_completely: bool = True, scheduler_shutdown: bool = True, scheduler_wait: bool = True
|
||||
) -> None:
|
||||
try:
|
||||
await self.send_message(
|
||||
chat_id=self.owner
|
||||
chat_id=(
|
||||
self.owner
|
||||
if self.config["reports"]["chat_id"] == "owner"
|
||||
else self.config["reports"]["chat_id"],
|
||||
else self.config["reports"]["chat_id"]
|
||||
),
|
||||
text=f"Bot stopped with PID `{getpid()}`",
|
||||
)
|
||||
await asyncio.sleep(0.5)
|
||||
except BadRequest:
|
||||
logger.warning("Unable to send message to report chat.")
|
||||
|
||||
if self.scheduler is not None and scheduler_shutdown:
|
||||
self.scheduler.shutdown(scheduler_wait)
|
||||
|
||||
await super().stop()
|
||||
logger.warning("Bot stopped with PID %s.", getpid())
|
||||
|
||||
if exit_completely:
|
||||
try:
|
||||
exit()
|
||||
except SystemExit as exp:
|
||||
raise SystemExit(
|
||||
"Bot has been shut down, this is not an application error!"
|
||||
) from exp
|
||||
sys.exit()
|
||||
except SystemExit as exc:
|
||||
raise SystemExit("Bot has been shut down, this is not an application error!") from exc
|
||||
|
||||
async def collect_commands(self) -> Union[List[CommandSet], None]:
|
||||
async def collect_commands(self) -> List[CommandSet] | None:
|
||||
"""Gather list of the bot's commands
|
||||
|
||||
### Returns:
|
||||
* `List[CommandSet]`: List of the commands' sets
|
||||
* `List[CommandSet]`: List of the commands' sets.
|
||||
"""
|
||||
command_sets = None
|
||||
|
||||
@@ -197,13 +258,9 @@ class PyroClient(Client):
|
||||
scopes[dumps(scope)] = {"_": []}
|
||||
|
||||
# Add command to the scope's flattened key in scopes dict
|
||||
scopes[dumps(scope)]["_"].append(
|
||||
BotCommand(command, _(command, "commands"))
|
||||
)
|
||||
scopes[dumps(scope)]["_"].append(BotCommand(command, _(command, "commands")))
|
||||
|
||||
for locale, string in (
|
||||
self.in_every_locale(command, "commands")
|
||||
).items():
|
||||
for locale, string in (self.in_every_locale(command, "commands")).items():
|
||||
if locale not in scopes[dumps(scope)]:
|
||||
scopes[dumps(scope)][locale] = []
|
||||
|
||||
@@ -222,11 +279,7 @@ class PyroClient(Client):
|
||||
# Create object with the same name and args from the dict
|
||||
try:
|
||||
scope_obj = globals()[scope_dict["name"]](
|
||||
**{
|
||||
key: value
|
||||
for key, value in scope_dict.items()
|
||||
if key != "name"
|
||||
}
|
||||
**{key: value for key, value in scope_dict.items() if key != "name"}
|
||||
)
|
||||
except NameError:
|
||||
logger.error(
|
||||
@@ -244,13 +297,9 @@ class PyroClient(Client):
|
||||
# Add set of commands to the list of the command sets
|
||||
for locale, commands in locales.items():
|
||||
if locale == "_":
|
||||
command_sets.append(
|
||||
CommandSet(commands, scope=scope_obj, language_code="")
|
||||
)
|
||||
command_sets.append(CommandSet(commands, scope=scope_obj, language_code=""))
|
||||
continue
|
||||
command_sets.append(
|
||||
CommandSet(commands, scope=scope_obj, language_code=locale)
|
||||
)
|
||||
command_sets.append(CommandSet(commands, scope=scope_obj, language_code=locale))
|
||||
|
||||
logger.info("Registering the following command sets: %s", command_sets)
|
||||
|
||||
@@ -258,7 +307,9 @@ class PyroClient(Client):
|
||||
# This part here looks into the handlers and looks for commands
|
||||
# in it, if there are any. Then adds them to self.commands
|
||||
for handler in self.dispatcher.groups[0]:
|
||||
if isinstance(handler, MessageHandler):
|
||||
if isinstance(handler, MessageHandler) and (
|
||||
hasattr(handler.filters, "base") or hasattr(handler.filters, "other")
|
||||
):
|
||||
for entry in [handler.filters.base, handler.filters.other]:
|
||||
if hasattr(entry, "commands"):
|
||||
for command in entry.commands:
|
||||
@@ -287,9 +338,7 @@ class PyroClient(Client):
|
||||
command,
|
||||
)
|
||||
|
||||
async def register_commands(
|
||||
self, command_sets: Union[List[CommandSet], None] = None
|
||||
) -> None:
|
||||
async def register_commands(self, command_sets: List[CommandSet] | None = None) -> None:
|
||||
"""Register commands stored in bot's 'commands' attribute"""
|
||||
|
||||
if command_sets is None:
|
||||
@@ -298,9 +347,7 @@ class PyroClient(Client):
|
||||
for command in self.commands
|
||||
]
|
||||
|
||||
logger.info(
|
||||
"Registering commands %s with a default scope 'BotCommandScopeDefault'"
|
||||
)
|
||||
logger.info("Registering commands %s with a default scope 'BotCommandScopeDefault'", commands)
|
||||
|
||||
await self.set_bot_commands(commands)
|
||||
return
|
||||
@@ -318,15 +365,11 @@ class PyroClient(Client):
|
||||
language_code=command_set.language_code,
|
||||
)
|
||||
|
||||
async def remove_commands(
|
||||
self, command_sets: Union[List[CommandSet], None] = None
|
||||
) -> None:
|
||||
async def remove_commands(self, command_sets: List[CommandSet] | None = None) -> None:
|
||||
"""Remove commands stored in bot's 'commands' attribute"""
|
||||
|
||||
if command_sets is None:
|
||||
logger.info(
|
||||
"Removing commands with a default scope 'BotCommandScopeDefault'"
|
||||
)
|
||||
logger.info("Removing commands with a default scope 'BotCommandScopeDefault'")
|
||||
await self.delete_bot_commands(BotCommandScopeDefault())
|
||||
return
|
||||
|
||||
|
@@ -1,5 +1,5 @@
|
||||
from dataclasses import dataclass
|
||||
from typing import List, Union
|
||||
from typing import List
|
||||
|
||||
try:
|
||||
from pyrogram.types import (
|
||||
@@ -13,9 +13,7 @@ try:
|
||||
BotCommandScopeDefault,
|
||||
)
|
||||
except ImportError as exc:
|
||||
raise ImportError(
|
||||
"You need to install libbot[pyrogram] in order to use this class."
|
||||
) from exc
|
||||
raise ImportError("You need to install libbot[pyrogram] in order to use this class.") from exc
|
||||
|
||||
|
||||
@dataclass
|
||||
@@ -23,13 +21,13 @@ class CommandSet:
|
||||
"""Command stored in PyroClient's 'commands' attribute"""
|
||||
|
||||
commands: List[BotCommand]
|
||||
scope: Union[
|
||||
BotCommandScopeDefault,
|
||||
BotCommandScopeAllPrivateChats,
|
||||
BotCommandScopeAllGroupChats,
|
||||
BotCommandScopeAllChatAdministrators,
|
||||
BotCommandScopeChat,
|
||||
BotCommandScopeChatAdministrators,
|
||||
BotCommandScopeChatMember,
|
||||
] = BotCommandScopeDefault
|
||||
scope: (
|
||||
BotCommandScopeDefault
|
||||
| BotCommandScopeAllPrivateChats
|
||||
| BotCommandScopeAllGroupChats
|
||||
| BotCommandScopeAllChatAdministrators
|
||||
| BotCommandScopeChat
|
||||
| BotCommandScopeChatAdministrators
|
||||
| BotCommandScopeChatMember
|
||||
) = BotCommandScopeDefault
|
||||
language_code: str = ""
|
||||
|
@@ -1,116 +0,0 @@
|
||||
from pathlib import Path
|
||||
from typing import Any, Union
|
||||
|
||||
try:
|
||||
from ujson import dumps, loads
|
||||
except ImportError:
|
||||
from json import dumps, loads
|
||||
|
||||
|
||||
def json_read(path: Union[str, Path]) -> Any:
|
||||
"""Read contents of a JSON file
|
||||
|
||||
### Args:
|
||||
* path (`Union[str, Path]`): Path-like object or path as a string
|
||||
|
||||
### Returns:
|
||||
* `Any`: File contents
|
||||
"""
|
||||
with open(str(path), mode="r", encoding="utf-8") as f:
|
||||
data = f.read()
|
||||
return loads(data)
|
||||
|
||||
|
||||
def json_write(data: Any, path: Union[str, Path]) -> None:
|
||||
"""Write contents to a JSON file
|
||||
|
||||
### Args:
|
||||
* data (`Any`): Contents to write. Must be a JSON serializable
|
||||
* path (`Union[str, Path]`): Path-like object or path as a string of a destination
|
||||
"""
|
||||
with open(str(path), mode="w", encoding="utf-8") as f:
|
||||
f.write(
|
||||
dumps(data, ensure_ascii=False, escape_forward_slashes=False, indent=4)
|
||||
if hasattr(dumps, "escape_forward_slashes")
|
||||
else dumps(data, ensure_ascii=False, indent=4)
|
||||
)
|
||||
|
||||
|
||||
def nested_set(target: dict, value: Any, *path: str, create_missing=True) -> dict:
|
||||
"""Set the key by its path to the value
|
||||
|
||||
### Args:
|
||||
* 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`
|
||||
|
||||
### Returns:
|
||||
* `dict`: Changed dictionary
|
||||
"""
|
||||
d = target
|
||||
for key in path[:-1]:
|
||||
if key in d:
|
||||
d = d[key]
|
||||
elif create_missing:
|
||||
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 d or create_missing:
|
||||
d[path[-1]] = value
|
||||
return target
|
||||
|
||||
|
||||
def config_get(
|
||||
key: str, *path: str, config_file: Union[str, Path] = "config.json"
|
||||
) -> Any:
|
||||
"""Get a value of the config key by its path provided
|
||||
For example, `foo.bar.key` has a path of `"foo", "bar"` and the key `"key"`
|
||||
|
||||
### Args:
|
||||
* key (`str`): Key that contains the value
|
||||
* *path (`str`): Path to the key that contains the value
|
||||
* config_file (`Union[str, Path]`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
|
||||
|
||||
### Returns:
|
||||
* `Any`: Key's value
|
||||
|
||||
### Example:
|
||||
Get the "salary" of "Pete" from this JSON structure:
|
||||
```json
|
||||
{
|
||||
"users": {
|
||||
"Pete": {
|
||||
"salary": 10.0
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
This can be easily done with the following code:
|
||||
```python
|
||||
import libbot
|
||||
salary = libbot.sync.config_get("salary", "users", "Pete")
|
||||
```
|
||||
"""
|
||||
this_key = json_read(config_file)
|
||||
for dict_key in path:
|
||||
this_key = this_key[dict_key]
|
||||
return this_key[key]
|
||||
|
||||
|
||||
def config_set(
|
||||
key: str, value: Any, *path: str, config_file: Union[str, Path] = "config.json"
|
||||
) -> None:
|
||||
"""Set config's key by its path to the value
|
||||
|
||||
### Args:
|
||||
* key (`str`): Key that leads to the value
|
||||
* value (`Any`): Any JSON serializable data
|
||||
* *path (`str`): Path to the key of the target
|
||||
* config_file (`Union[str, Path]`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
|
||||
"""
|
||||
json_write(nested_set(json_read(config_file), value, *(*path, key)), config_file)
|
||||
return
|
3
src/libbot/utils/__init__.py
Normal file
3
src/libbot/utils/__init__.py
Normal file
@@ -0,0 +1,3 @@
|
||||
from . import misc
|
||||
from .config import config_get, config_set, config_delete
|
||||
from .json import json_read, json_write
|
1
src/libbot/utils/config/__init__.py
Normal file
1
src/libbot/utils/config/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
from ._functions import config_get, config_set, config_delete
|
163
src/libbot/utils/config/_functions.py
Normal file
163
src/libbot/utils/config/_functions.py
Normal file
@@ -0,0 +1,163 @@
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict
|
||||
|
||||
from ..json import json_read, json_write
|
||||
from ..misc import nested_delete, nested_set
|
||||
from ..syncs import asyncable
|
||||
|
||||
try:
|
||||
from ujson import dumps, loads
|
||||
except ImportError:
|
||||
from json import dumps, loads
|
||||
|
||||
DEFAULT_CONFIG_LOCATION: str = "config.json"
|
||||
|
||||
|
||||
@asyncable
|
||||
def config_get(key: str, *path: str, config_file: str | Path = DEFAULT_CONFIG_LOCATION) -> Any:
|
||||
"""Get a value of the config key by its path provided.
|
||||
For example, `foo.bar.key` has a path of `"foo", "bar"` and the key `"key"`.
|
||||
|
||||
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)
|
||||
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:
|
||||
Any: Key's value
|
||||
|
||||
Example:
|
||||
Get the "salary" of "Pete" from this JSON structure: `{"users": {"Pete": {"salary": 10.0}}}`
|
||||
|
||||
This can be easily done with the following code:
|
||||
|
||||
>>> import libbot
|
||||
salary: float = libbot.sync.config_get("salary", "users", "Pete")
|
||||
"""
|
||||
this_key: Dict[str, Any] = json_read(config_file)
|
||||
|
||||
for dict_key in path:
|
||||
this_key = this_key[dict_key]
|
||||
|
||||
return this_key[key]
|
||||
|
||||
|
||||
@config_get.asynchronous
|
||||
async def config_get(key: str, *path: str, config_file: str | Path = DEFAULT_CONFIG_LOCATION) -> Any:
|
||||
"""Get a value of the config key by its path provided.
|
||||
For example, `foo.bar.key` has a path of `"foo", "bar"` and the key `"key"`.
|
||||
|
||||
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)
|
||||
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:
|
||||
Any: Key's value
|
||||
|
||||
Example:
|
||||
Get the "salary" of "Pete" from this JSON structure: `{"users": {"Pete": {"salary": 10.0}}}`
|
||||
|
||||
This can be easily done with the following code:
|
||||
|
||||
>>> import libbot
|
||||
salary: float = libbot.sync.config_get("salary", "users", "Pete")
|
||||
"""
|
||||
this_key: Dict[str, Any] = await json_read(config_file)
|
||||
|
||||
for dict_key in path:
|
||||
this_key = this_key[dict_key]
|
||||
|
||||
return this_key[key]
|
||||
|
||||
|
||||
@asyncable
|
||||
def config_set(key: str, value: Any, *path: str, config_file: str | Path = DEFAULT_CONFIG_LOCATION) -> None:
|
||||
"""Set config's key by its path to the value.
|
||||
|
||||
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).
|
||||
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:
|
||||
KeyError: Key was not found under the provided path.
|
||||
"""
|
||||
json_write(nested_set(json_read(config_file), value, *(*path, key)), config_file)
|
||||
|
||||
|
||||
@config_set.asynchronous
|
||||
async def config_set(
|
||||
key: str, value: Any, *path: str, config_file: str | Path = DEFAULT_CONFIG_LOCATION
|
||||
) -> None:
|
||||
"""Set config's key by its path to the value.
|
||||
|
||||
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).
|
||||
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:
|
||||
KeyError: Key was not found under the provided path.
|
||||
"""
|
||||
await json_write(nested_set(await json_read(config_file), value, *(*path, key)), config_file)
|
||||
|
||||
|
||||
@asyncable
|
||||
def config_delete(
|
||||
key: str,
|
||||
*path: str,
|
||||
missing_ok: bool = False,
|
||||
config_file: str | Path = DEFAULT_CONFIG_LOCATION,
|
||||
) -> None:
|
||||
"""Delete config's key by its path.
|
||||
|
||||
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)
|
||||
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".
|
||||
|
||||
Raises:
|
||||
KeyError: Key is not found under path provided and `missing_ok` is False.
|
||||
"""
|
||||
config_data: Dict[str, Any] = json_read(config_file)
|
||||
|
||||
try:
|
||||
nested_delete(config_data, *(*path, key))
|
||||
except KeyError as exc:
|
||||
if not missing_ok:
|
||||
raise exc from exc
|
||||
|
||||
json_write(config_data, config_file)
|
||||
|
||||
|
||||
@config_delete.asynchronous
|
||||
async def config_delete(
|
||||
key: str,
|
||||
*path: str,
|
||||
missing_ok: bool = False,
|
||||
config_file: str | Path = DEFAULT_CONFIG_LOCATION,
|
||||
) -> None:
|
||||
"""Delete config's key by its path.
|
||||
|
||||
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)
|
||||
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".
|
||||
|
||||
Raises:
|
||||
KeyError: Key is not found under path provided and `missing_ok` is False.
|
||||
"""
|
||||
config_data: Dict[str, Any] = await json_read(config_file)
|
||||
|
||||
try:
|
||||
nested_delete(config_data, *(*path, key))
|
||||
except KeyError as exc:
|
||||
if not missing_ok:
|
||||
raise exc from exc
|
||||
|
||||
await json_write(config_data, config_file)
|
1
src/libbot/utils/json/__init__.py
Normal file
1
src/libbot/utils/json/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
from ._functions import json_read, json_write
|
76
src/libbot/utils/json/_functions.py
Normal file
76
src/libbot/utils/json/_functions.py
Normal file
@@ -0,0 +1,76 @@
|
||||
from pathlib import Path
|
||||
from typing import Any
|
||||
|
||||
import aiofiles
|
||||
|
||||
from ..misc import supports_argument
|
||||
from ..syncs import asyncable
|
||||
|
||||
try:
|
||||
from ujson import dumps, loads
|
||||
except ImportError:
|
||||
from json import dumps, loads
|
||||
|
||||
|
||||
@asyncable
|
||||
def json_read(path: str | Path) -> Any:
|
||||
"""Read contents of a JSON file and return it.
|
||||
|
||||
Args:
|
||||
path (str | Path): Path-like object or path to the file as a string.
|
||||
|
||||
Returns:
|
||||
Any: File contents.
|
||||
"""
|
||||
with open(str(path), mode="r", encoding="utf-8") as f:
|
||||
data = f.read()
|
||||
|
||||
return loads(data)
|
||||
|
||||
|
||||
@json_read.asynchronous
|
||||
async def json_read(path: str | Path) -> Any:
|
||||
"""Read contents of a JSON file and return it.
|
||||
|
||||
Args:
|
||||
path (str | Path): Path-like object or path to the file as a string.
|
||||
|
||||
Returns:
|
||||
Any: File contents.
|
||||
"""
|
||||
async with aiofiles.open(str(path), mode="r", encoding="utf-8") as f:
|
||||
data = await f.read()
|
||||
|
||||
return loads(data)
|
||||
|
||||
|
||||
@asyncable
|
||||
def json_write(data: Any, path: str | Path) -> None:
|
||||
"""Write contents to a JSON file.
|
||||
|
||||
Args:
|
||||
data (Any): Contents to write. Must be a JSON-serializable object.
|
||||
path (str | Path): Path-like object or path to the file as a string.
|
||||
"""
|
||||
with open(str(path), mode="w", encoding="utf-8") as f:
|
||||
f.write(
|
||||
dumps(data, ensure_ascii=False, escape_forward_slashes=False, indent=4)
|
||||
if supports_argument(dumps, "escape_forward_slashes")
|
||||
else dumps(data, ensure_ascii=False, indent=4)
|
||||
)
|
||||
|
||||
|
||||
@json_write.asynchronous
|
||||
async def json_write(data: Any, path: str | Path) -> None:
|
||||
"""Write contents to a JSON file.
|
||||
|
||||
Args:
|
||||
data (Any): Contents to write. Must be a JSON-serializable object.
|
||||
path (str | Path): Path-like object or path to the file as a string.
|
||||
"""
|
||||
async with aiofiles.open(str(path), mode="w", encoding="utf-8") as f:
|
||||
await f.write(
|
||||
dumps(data, ensure_ascii=False, escape_forward_slashes=False, indent=4)
|
||||
if supports_argument(dumps, "escape_forward_slashes")
|
||||
else dumps(data, ensure_ascii=False, indent=4)
|
||||
)
|
1
src/libbot/utils/misc/__init__.py
Normal file
1
src/libbot/utils/misc/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
from ._functions import supports_argument, nested_set, nested_delete
|
87
src/libbot/utils/misc/_functions.py
Normal file
87
src/libbot/utils/misc/_functions.py
Normal file
@@ -0,0 +1,87 @@
|
||||
import inspect
|
||||
from typing import Any, Dict
|
||||
from typing import Callable
|
||||
|
||||
|
||||
def supports_argument(func: Callable[..., Any], arg_name: str) -> bool:
|
||||
"""Check whether a function has a specific argument.
|
||||
|
||||
Args:
|
||||
func (Callable[..., Any]): Function to be inspected.
|
||||
arg_name (str): Argument to be checked.
|
||||
|
||||
Returns:
|
||||
bool: True if argument is supported and False if not.
|
||||
"""
|
||||
if hasattr(func, "__code__"):
|
||||
return arg_name in inspect.signature(func).parameters
|
||||
|
||||
if hasattr(func, "__doc__"):
|
||||
if doc := func.__doc__:
|
||||
first_line = doc.splitlines()[0]
|
||||
return arg_name in first_line
|
||||
|
||||
return False
|
||||
|
||||
|
||||
def nested_set(
|
||||
target: Dict[str, Any], value: Any, *path: str, create_missing: bool = True
|
||||
) -> Dict[str, Any]:
|
||||
"""Set the key by its path to the value
|
||||
|
||||
Args:
|
||||
target (Dict[str, Any]): Dictionary to perform the modification on.
|
||||
value (Any): New value.
|
||||
*path (str): Path to the key.
|
||||
create_missing (:obj:`bool`, optional): Create keys on the way if they're missing. Defaults to True.
|
||||
|
||||
Raises:
|
||||
KeyError: Key is not found under the provided path.
|
||||
|
||||
Returns:
|
||||
Dict[str, Any]: Modified dictionary.
|
||||
"""
|
||||
target_copy: Dict[str, Any] = target
|
||||
|
||||
for key in path[:-1]:
|
||||
if key in target_copy:
|
||||
target_copy = target_copy[key]
|
||||
elif create_missing:
|
||||
target_copy = target_copy.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
|
||||
|
||||
return target
|
||||
|
||||
|
||||
def nested_delete(target: Dict[str, Any], *path: str) -> Dict[str, Any]:
|
||||
"""Delete the key by its path.
|
||||
|
||||
Args:
|
||||
target (Dict[str, Any]): Dictionary to perform the modification on.
|
||||
|
||||
Raises:
|
||||
KeyError: Key is not found under the provided path.
|
||||
|
||||
Returns:
|
||||
Dict[str, Any]: Modified dictionary.
|
||||
"""
|
||||
target_copy: Dict[str, Any] = target
|
||||
|
||||
for key in path[:-1]:
|
||||
if key in target_copy:
|
||||
target_copy = target_copy[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]]
|
||||
else:
|
||||
raise KeyError(f"Key '{path[-1]}' is not found under path provided ({path})")
|
||||
|
||||
return target
|
1
src/libbot/utils/syncs/__init__.py
Normal file
1
src/libbot/utils/syncs/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
from ._syncs import asyncable
|
69
src/libbot/utils/syncs/_syncs.py
Normal file
69
src/libbot/utils/syncs/_syncs.py
Normal file
@@ -0,0 +1,69 @@
|
||||
import asyncio
|
||||
import inspect
|
||||
from inspect import FrameInfo
|
||||
from typing import Any, Callable, Optional, Type
|
||||
|
||||
|
||||
class asyncable:
|
||||
"""Allows to mark a callable able to be async.
|
||||
|
||||
Source: https://itsjohannawren.medium.com/single-call-sync-and-async-in-python-2acadd07c9d6"""
|
||||
|
||||
def __init__(self, method: Callable):
|
||||
self.__sync = method
|
||||
self.__async = None
|
||||
|
||||
def asynchronous(self, method: Callable) -> "asyncable":
|
||||
if not isinstance(method, Callable):
|
||||
raise RuntimeError("NOT CALLABLE!!!")
|
||||
|
||||
self.__async = method
|
||||
return self
|
||||
|
||||
@staticmethod
|
||||
def __is_awaited() -> bool:
|
||||
frame: FrameInfo = inspect.stack()[2]
|
||||
|
||||
if not hasattr(frame, "positions"):
|
||||
return False
|
||||
|
||||
return (
|
||||
frame.positions.col_offset >= 6
|
||||
and frame.code_context[frame.index][frame.positions.col_offset - 6 : frame.positions.col_offset]
|
||||
== "await "
|
||||
)
|
||||
|
||||
def __get__(
|
||||
self,
|
||||
instance: Type,
|
||||
*args,
|
||||
owner_class: Optional[Type[Type]] = None,
|
||||
**kwargs,
|
||||
) -> Callable:
|
||||
if self.__is_awaited():
|
||||
if self.__async is None:
|
||||
raise RuntimeError(
|
||||
"Attempting to call asyncable with await, but no asynchronous call has been defined"
|
||||
)
|
||||
|
||||
bound_method = self.__async.__get__(instance, owner_class)
|
||||
|
||||
if isinstance(self.__sync, classmethod):
|
||||
return lambda: asyncio.ensure_future(bound_method(owner_class, *args, **kwargs))
|
||||
|
||||
return lambda: asyncio.ensure_future(bound_method(*args, **kwargs))
|
||||
|
||||
bound_method = self.__sync.__get__(instance, owner_class)
|
||||
|
||||
return lambda: bound_method(*args, **kwargs)
|
||||
|
||||
def __call__(self, *args, **kwargs) -> Any:
|
||||
if self.__is_awaited():
|
||||
if self.__async is None:
|
||||
raise RuntimeError(
|
||||
"Attempting to call asyncable with await, but no asynchronous call has been defined"
|
||||
)
|
||||
|
||||
return asyncio.ensure_future(self.__async(*args, **kwargs))
|
||||
|
||||
return self.__sync(*args, **kwargs)
|
@@ -2,5 +2,14 @@
|
||||
"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,4 +1,7 @@
|
||||
from json import dumps, loads
|
||||
from os import makedirs
|
||||
from pathlib import Path
|
||||
from uuid import uuid4
|
||||
|
||||
import pytest
|
||||
|
||||
@@ -7,7 +10,22 @@ from libbot.i18n import BotLocale
|
||||
|
||||
@pytest.fixture()
|
||||
def location_config() -> Path:
|
||||
return Path("tests/config.json")
|
||||
makedirs(Path("tests/.tmp"), exist_ok=True)
|
||||
|
||||
filename = str(uuid4())
|
||||
|
||||
with open(Path("tests/config.json"), "r", encoding="utf-8") as file:
|
||||
config = loads(file.read())
|
||||
|
||||
with open(Path(f"tests/.tmp/{filename}.json"), "w", encoding="utf-8") as file:
|
||||
file.write(
|
||||
dumps(
|
||||
config,
|
||||
ensure_ascii=False,
|
||||
indent=4,
|
||||
)
|
||||
)
|
||||
return Path(f"tests/.tmp/{filename}.json")
|
||||
|
||||
|
||||
@pytest.fixture()
|
||||
|
@@ -1,4 +1,16 @@
|
||||
{
|
||||
"metadata": {
|
||||
"flag": "🇬🇧",
|
||||
"name": "English",
|
||||
"codes": [
|
||||
"en"
|
||||
]
|
||||
},
|
||||
"bot": {
|
||||
"name": "",
|
||||
"about": "",
|
||||
"description": ""
|
||||
},
|
||||
"foo": "bar",
|
||||
"messages": {
|
||||
"example": "okay"
|
||||
|
@@ -1,4 +1,16 @@
|
||||
{
|
||||
"metadata": {
|
||||
"flag": "🇺🇦",
|
||||
"name": "Українська",
|
||||
"codes": [
|
||||
"uk"
|
||||
]
|
||||
},
|
||||
"bot": {
|
||||
"name": "",
|
||||
"about": "",
|
||||
"description": ""
|
||||
},
|
||||
"foo": "бар",
|
||||
"messages": {
|
||||
"example": "окей"
|
||||
|
@@ -1,8 +1,6 @@
|
||||
from pathlib import Path
|
||||
from typing import Any, List, Union
|
||||
from typing import Any, List
|
||||
|
||||
import pytest
|
||||
|
||||
from libbot.i18n import BotLocale
|
||||
|
||||
|
||||
@@ -20,14 +18,12 @@ from libbot.i18n import BotLocale
|
||||
def test_bot_locale_get(
|
||||
key: str,
|
||||
args: List[str],
|
||||
locale: Union[str, None],
|
||||
locale: str | None,
|
||||
expected: Any,
|
||||
bot_locale: BotLocale,
|
||||
):
|
||||
assert (
|
||||
bot_locale._(key, *args, locale=locale)
|
||||
if locale is not None
|
||||
else bot_locale._(key, *args)
|
||||
bot_locale._(key, *args, locale=locale) if locale is not None else bot_locale._(key, *args)
|
||||
) == expected
|
||||
|
||||
|
||||
@@ -39,9 +35,7 @@ def test_bot_locale_get(
|
||||
("nested", ["callbacks", "default"], ["sure", "авжеж"]),
|
||||
],
|
||||
)
|
||||
def test_i18n_in_all_locales(
|
||||
key: str, args: List[str], expected: Any, bot_locale: BotLocale
|
||||
):
|
||||
def test_i18n_in_all_locales(key: str, args: List[str], expected: Any, bot_locale: BotLocale):
|
||||
assert (bot_locale.in_all_locales(key, *args)) == expected
|
||||
|
||||
|
||||
@@ -53,7 +47,5 @@ def test_i18n_in_all_locales(
|
||||
("nested", ["callbacks", "default"], {"en": "sure", "uk": "авжеж"}),
|
||||
],
|
||||
)
|
||||
def test_i18n_in_every_locale(
|
||||
key: str, args: List[str], expected: Any, bot_locale: BotLocale
|
||||
):
|
||||
def test_i18n_in_every_locale(key: str, args: List[str], expected: Any, bot_locale: BotLocale):
|
||||
assert (bot_locale.in_every_locale(key, *args)) == expected
|
||||
|
28
tests/test_cache.py
Normal file
28
tests/test_cache.py
Normal file
@@ -0,0 +1,28 @@
|
||||
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)
|
@@ -2,8 +2,7 @@ from pathlib import Path
|
||||
from typing import Any, List
|
||||
|
||||
import pytest
|
||||
|
||||
from libbot import config_get, config_set
|
||||
from libbot.utils import config_delete, config_get, config_set
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
@@ -25,14 +24,9 @@ async def test_config_get_valid(args: List[str], expected: str, location_config:
|
||||
(["bot_stonks", "bot"], pytest.raises(KeyError)),
|
||||
],
|
||||
)
|
||||
async def test_config_get_invalid(
|
||||
args: List[str], expected: Any, location_config: Path
|
||||
):
|
||||
async def test_config_get_invalid(args: List[str], expected: Any, location_config: Path):
|
||||
with expected:
|
||||
assert (
|
||||
await config_get(args[0], *args[1:], config_file=location_config)
|
||||
== expected
|
||||
)
|
||||
assert await config_get(args[0], *args[1:], config_file=location_config) == expected
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
@@ -46,3 +40,26 @@ async def test_config_get_invalid(
|
||||
async def test_config_set(key: str, path: List[str], value: Any, location_config: Path):
|
||||
await config_set(key, value, *path, config_file=location_config)
|
||||
assert await config_get(key, *path, config_file=location_config) == value
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
@pytest.mark.parametrize(
|
||||
"key, path",
|
||||
[
|
||||
("bot_token", ["bot"]),
|
||||
],
|
||||
)
|
||||
async def test_config_delete(key: str, path: List[str], location_config: Path):
|
||||
await config_delete(key, *path, config_file=location_config)
|
||||
assert key not in (await config_get(*path, config_file=location_config))
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
@pytest.mark.parametrize(
|
||||
"key, path",
|
||||
[
|
||||
("bot_lol", ["bot"]),
|
||||
],
|
||||
)
|
||||
async def test_config_delete_missing(key: str, path: List[str], location_config: Path):
|
||||
assert await config_delete(key, *path, missing_ok=True, config_file=location_config) is None
|
||||
|
@@ -2,8 +2,7 @@ from pathlib import Path
|
||||
from typing import Any, List
|
||||
|
||||
import pytest
|
||||
|
||||
from libbot import sync
|
||||
from libbot.utils import config_delete, config_get, config_set
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
@@ -13,8 +12,8 @@ from libbot import sync
|
||||
(["bot_token", "bot"], "sample_token"),
|
||||
],
|
||||
)
|
||||
def test_config_get_valid(args: List[str], expected: str, location_config: Path):
|
||||
assert sync.config_get(args[0], *args[1:], config_file=location_config) == expected
|
||||
async def test_config_get_valid(args: List[str], expected: str, location_config: Path):
|
||||
assert config_get(args[0], *args[1:], config_file=location_config) == expected
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
@@ -25,9 +24,7 @@ def test_config_get_valid(args: List[str], expected: str, location_config: Path)
|
||||
)
|
||||
def test_config_get_invalid(args: List[str], expected: Any, location_config: Path):
|
||||
with expected:
|
||||
assert (
|
||||
sync.config_get(args[0], *args[1:], config_file=location_config) == expected
|
||||
)
|
||||
assert config_get(args[0], *args[1:], config_file=location_config) == expected
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
@@ -38,5 +35,26 @@ def test_config_get_invalid(args: List[str], expected: Any, location_config: Pat
|
||||
],
|
||||
)
|
||||
def test_config_set(key: str, path: List[str], value: Any, location_config: Path):
|
||||
sync.config_set(key, value, *path, config_file=location_config)
|
||||
assert sync.config_get(key, *path, config_file=location_config) == value
|
||||
config_set(key, value, *path, config_file=location_config)
|
||||
assert config_get(key, *path, config_file=location_config) == value
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"key, path",
|
||||
[
|
||||
("bot_token", ["bot"]),
|
||||
],
|
||||
)
|
||||
def test_config_delete(key: str, path: List[str], location_config: Path):
|
||||
config_delete(key, *path, config_file=location_config)
|
||||
assert key not in config_get(*path, config_file=location_config)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"key, path",
|
||||
[
|
||||
("bot_lol", ["bot"]),
|
||||
],
|
||||
)
|
||||
def test_config_delete_missing(key: str, path: List[str], location_config: Path):
|
||||
assert config_delete(key, *path, missing_ok=True, config_file=location_config) is None
|
||||
|
@@ -1,8 +1,7 @@
|
||||
from pathlib import Path
|
||||
from typing import Any, List, Union
|
||||
from typing import Any, List
|
||||
|
||||
import pytest
|
||||
|
||||
from libbot import i18n
|
||||
|
||||
|
||||
@@ -21,7 +20,7 @@ from libbot import i18n
|
||||
async def test_i18n_get(
|
||||
key: str,
|
||||
args: List[str],
|
||||
locale: Union[str, None],
|
||||
locale: str | None,
|
||||
expected: Any,
|
||||
location_locale: Path,
|
||||
):
|
||||
@@ -41,12 +40,8 @@ async def test_i18n_get(
|
||||
("nested", ["callbacks", "default"], ["sure", "авжеж"]),
|
||||
],
|
||||
)
|
||||
async def test_i18n_in_all_locales(
|
||||
key: str, args: List[str], expected: Any, location_locale: Path
|
||||
):
|
||||
assert (
|
||||
await i18n.in_all_locales(key, *args, locales_root=location_locale)
|
||||
) == expected
|
||||
async def test_i18n_in_all_locales(key: str, args: List[str], expected: Any, location_locale: Path):
|
||||
assert (await i18n.in_all_locales(key, *args, locales_root=location_locale)) == expected
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
@@ -58,9 +53,5 @@ async def test_i18n_in_all_locales(
|
||||
("nested", ["callbacks", "default"], {"en": "sure", "uk": "авжеж"}),
|
||||
],
|
||||
)
|
||||
async def test_i18n_in_every_locale(
|
||||
key: str, args: List[str], expected: Any, location_locale: Path
|
||||
):
|
||||
assert (
|
||||
await i18n.in_every_locale(key, *args, locales_root=location_locale)
|
||||
) == expected
|
||||
async def test_i18n_in_every_locale(key: str, args: List[str], expected: Any, location_locale: Path):
|
||||
assert (await i18n.in_every_locale(key, *args, locales_root=location_locale)) == expected
|
||||
|
@@ -1,9 +1,8 @@
|
||||
from pathlib import Path
|
||||
from typing import Any, List, Union
|
||||
from typing import Any, List
|
||||
|
||||
import pytest
|
||||
|
||||
from libbot.i18n import sync
|
||||
from libbot.i18n import _, in_all_locales, in_every_locale
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
@@ -20,14 +19,14 @@ from libbot.i18n import sync
|
||||
def test_i18n_get(
|
||||
key: str,
|
||||
args: List[str],
|
||||
locale: Union[str, None],
|
||||
locale: str | None,
|
||||
expected: Any,
|
||||
location_locale: Path,
|
||||
):
|
||||
assert (
|
||||
sync._(key, *args, locale=locale, locales_root=location_locale)
|
||||
_(key, *args, locale=locale, locales_root=location_locale)
|
||||
if locale is not None
|
||||
else sync._(key, *args, locales_root=location_locale)
|
||||
else _(key, *args, locales_root=location_locale)
|
||||
) == expected
|
||||
|
||||
|
||||
@@ -39,10 +38,8 @@ def test_i18n_get(
|
||||
("nested", ["callbacks", "default"], ["sure", "авжеж"]),
|
||||
],
|
||||
)
|
||||
def test_i18n_in_all_locales(
|
||||
key: str, args: List[str], expected: Any, location_locale: Path
|
||||
):
|
||||
assert (sync.in_all_locales(key, *args, locales_root=location_locale)) == expected
|
||||
def test_i18n_in_all_locales(key: str, args: List[str], expected: Any, location_locale: Path):
|
||||
assert (in_all_locales(key, *args, locales_root=location_locale)) == expected
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
@@ -53,7 +50,5 @@ def test_i18n_in_all_locales(
|
||||
("nested", ["callbacks", "default"], {"en": "sure", "uk": "авжеж"}),
|
||||
],
|
||||
)
|
||||
def test_i18n_in_every_locale(
|
||||
key: str, args: List[str], expected: Any, location_locale: Path
|
||||
):
|
||||
assert (sync.in_every_locale(key, *args, locales_root=location_locale)) == expected
|
||||
def test_i18n_in_every_locale(key: str, args: List[str], expected: Any, location_locale: Path):
|
||||
assert (in_every_locale(key, *args, locales_root=location_locale)) == expected
|
||||
|
@@ -4,11 +4,10 @@ except ImportError:
|
||||
from json import dumps, JSONDecodeError
|
||||
|
||||
from pathlib import Path
|
||||
from typing import Any, Union
|
||||
from typing import Any
|
||||
|
||||
import pytest
|
||||
|
||||
from libbot import json_read, json_write
|
||||
from libbot.utils import json_read, json_write
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
@@ -25,7 +24,7 @@ from libbot import json_read, json_write
|
||||
("tests/data/empty.json", {}),
|
||||
],
|
||||
)
|
||||
async def test_json_read_valid(path: Union[str, Path], expected: Any):
|
||||
async def test_json_read_valid(path: str | Path, expected: Any):
|
||||
assert await json_read(path) == expected
|
||||
|
||||
|
||||
@@ -37,7 +36,7 @@ async def test_json_read_valid(path: Union[str, Path], expected: Any):
|
||||
("tests/data/nonexistent.json", FileNotFoundError),
|
||||
],
|
||||
)
|
||||
async def test_json_read_invalid(path: Union[str, Path], expected: Any):
|
||||
async def test_json_read_invalid(path: str | Path, expected: Any):
|
||||
with pytest.raises(expected):
|
||||
await json_read(path)
|
||||
|
||||
@@ -56,7 +55,7 @@ async def test_json_read_invalid(path: Union[str, Path], expected: Any):
|
||||
({}, "tests/data/empty.json"),
|
||||
],
|
||||
)
|
||||
async def test_json_write(data: Any, path: Union[str, Path]):
|
||||
async def test_json_write(data: Any, path: str | Path):
|
||||
await json_write(data, path)
|
||||
|
||||
assert Path(path).is_file()
|
||||
|
@@ -4,11 +4,10 @@ except ImportError:
|
||||
from json import dumps, JSONDecodeError
|
||||
|
||||
from pathlib import Path
|
||||
from typing import Any, Union
|
||||
from typing import Any
|
||||
|
||||
import pytest
|
||||
|
||||
from libbot import sync
|
||||
from libbot.utils import json_read, json_write
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
@@ -24,8 +23,8 @@ from libbot import sync
|
||||
("tests/data/empty.json", {}),
|
||||
],
|
||||
)
|
||||
def test_json_read_valid(path: Union[str, Path], expected: Any):
|
||||
assert sync.json_read(path) == expected
|
||||
def test_json_read_valid(path: str | Path, expected: Any):
|
||||
assert json_read(path) == expected
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
@@ -35,9 +34,9 @@ def test_json_read_valid(path: Union[str, Path], expected: Any):
|
||||
("tests/data/nonexistent.json", FileNotFoundError),
|
||||
],
|
||||
)
|
||||
def test_json_read_invalid(path: Union[str, Path], expected: Any):
|
||||
def test_json_read_invalid(path: str | Path, expected: Any):
|
||||
with pytest.raises(expected):
|
||||
assert sync.json_read(path) == expected
|
||||
assert json_read(path) == expected
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
@@ -53,8 +52,8 @@ def test_json_read_invalid(path: Union[str, Path], expected: Any):
|
||||
({}, "tests/data/empty.json"),
|
||||
],
|
||||
)
|
||||
def test_json_write(data: Any, path: Union[str, Path]):
|
||||
sync.json_write(data, path)
|
||||
def test_json_write(data: Any, path: str | Path):
|
||||
json_write(data, path)
|
||||
|
||||
assert Path(path).is_file()
|
||||
with open(path, "r", encoding="utf-8") as f:
|
||||
|
@@ -1,8 +1,7 @@
|
||||
from typing import Any, Dict, List
|
||||
|
||||
import pytest
|
||||
|
||||
from libbot import sync
|
||||
from libbot.utils.misc import nested_delete, nested_set
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
@@ -33,9 +32,7 @@ def test_nested_set_valid(
|
||||
create_missing: bool,
|
||||
expected: Any,
|
||||
):
|
||||
assert (
|
||||
sync.nested_set(target, value, *path, create_missing=create_missing)
|
||||
) == expected
|
||||
assert (nested_set(target, value, *path, create_missing=create_missing)) == expected
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
@@ -58,6 +55,24 @@ def test_nested_set_invalid(
|
||||
expected: Any,
|
||||
):
|
||||
with pytest.raises(expected):
|
||||
assert (
|
||||
sync.nested_set(target, value, *path, create_missing=create_missing)
|
||||
) == expected
|
||||
assert (nested_set(target, value, *path, create_missing=create_missing)) == expected
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"target, path, expected",
|
||||
[
|
||||
({"foo": "bar"}, ["foo"], {}),
|
||||
({"foo": "bar", "bar": "foo"}, ["bar"], {"foo": "bar"}),
|
||||
(
|
||||
{"foo": {"bar": {}}},
|
||||
["foo", "bar"],
|
||||
{"foo": {}},
|
||||
),
|
||||
],
|
||||
)
|
||||
def test_nested_delete(
|
||||
target: Dict[str, Any],
|
||||
path: List[str],
|
||||
expected: Any,
|
||||
):
|
||||
assert (nested_delete(target, *path)) == expected
|
||||
|
25
tests/test_utils.py
Normal file
25
tests/test_utils.py
Normal file
@@ -0,0 +1,25 @@
|
||||
from typing import Callable
|
||||
|
||||
import pytest
|
||||
from libbot.utils.misc import supports_argument
|
||||
|
||||
|
||||
def func1(foo: str, bar: str):
|
||||
"""Dummy function with specific arguments"""
|
||||
pass
|
||||
|
||||
|
||||
def func2(foo: str):
|
||||
"""Dummy function with specific arguments"""
|
||||
pass
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"func, arg_name, result",
|
||||
[
|
||||
(func1, "foo", True),
|
||||
(func2, "bar", False),
|
||||
],
|
||||
)
|
||||
def test_supports_argument(func: Callable, arg_name: str, result: bool):
|
||||
assert supports_argument(func, arg_name) == result
|
10
tox.ini
10
tox.ini
@@ -1,14 +1,13 @@
|
||||
[tox]
|
||||
minversion = 3.8.0
|
||||
envlist = py38, py39, py310, py311
|
||||
minversion = 3.11.0
|
||||
envlist = py311, py312, py313
|
||||
isolated_build = true
|
||||
|
||||
[gh-actions]
|
||||
python =
|
||||
3.8: py38
|
||||
3.9: py39
|
||||
3.10: py310
|
||||
3.11: py311
|
||||
3.12: py312
|
||||
3.13: py313
|
||||
|
||||
[testenv]
|
||||
setenv =
|
||||
@@ -19,5 +18,6 @@ deps =
|
||||
-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