Compare commits

..

84 Commits

Author SHA1 Message Date
88786131f1 Merge branch 'dev' into profitroll/sphinx
# Conflicts:
#	src/libbot/i18n/_functions.py
#	src/libbot/i18n/classes/bot_locale.py
2025-07-09 14:39:19 +02:00
ef7380ae45 WIP: Documentation improvement and format change to Google
Some checks failed
Analysis / SonarCloud (push) Successful in 54s
Analysis / SonarCloud (pull_request) Successful in 48s
Tests / Build and Test (3.11) (pull_request) Failing after 1m2s
Tests / Build and Test (3.12) (pull_request) Failing after 1m0s
Tests / Build and Test (3.13) (pull_request) Failing after 59s
2025-07-09 14:32:50 +02:00
727d531d63 Added support for default_ttl_seconds in create_cache_client() 2025-07-09 14:31:55 +02:00
7d95b1efee Merge pull request 'Update dependency types-aiofiles to v24.1.0.20250708' (#222) from renovate/types-aiofiles-24.x into dev
All checks were successful
Analysis / SonarCloud (push) Successful in 57s
Reviewed-on: #222
2025-07-08 15:45:53 +03:00
03115b4059 Update dependency types-aiofiles to v24.1.0.20250708
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 44s
Tests / Build and Test (3.11) (pull_request) Successful in 1m12s
Tests / Build and Test (3.12) (pull_request) Successful in 1m13s
Tests / Build and Test (3.13) (pull_request) Successful in 1m7s
2025-07-08 06:48:18 +03:00
6038b5058f Merge pull request 'Update project for sphinx to use libbot 4.3.0' (#221) from dev into profitroll/sphinx
Reviewed-on: #221
2025-07-08 01:42:28 +03:00
e4ce5976f2 Changed default cache TTL to 0 and None for memcached and redis respectively
All checks were successful
Analysis / SonarCloud (push) Successful in 50s
Analysis / SonarCloud (pull_request) Successful in 52s
Tests / Build and Test (3.11) (pull_request) Successful in 1m14s
Tests / Build and Test (3.12) (pull_request) Successful in 1m20s
Tests / Build and Test (3.13) (pull_request) Successful in 1m18s
2025-07-08 00:01:14 +02:00
32a9e14d0c Added a default TTL of 300 seconds for cache entries (#219)
All checks were successful
Analysis / SonarCloud (push) Successful in 50s
Analysis / SonarCloud (pull_request) Successful in 1m4s
Tests / Build and Test (3.11) (pull_request) Successful in 1m14s
Tests / Build and Test (3.12) (pull_request) Successful in 1m15s
Tests / Build and Test (3.13) (pull_request) Successful in 1m19s
2025-07-07 23:47:55 +02:00
3110bb64b1 Closes #219
All checks were successful
Analysis / SonarCloud (push) Successful in 1m35s
2025-07-07 23:35:21 +02:00
ad38dbdca1 Update dependency pytest to v8.4.1
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 50s
Tests / Build and Test (3.11) (pull_request) Successful in 1m17s
Tests / Build and Test (3.12) (pull_request) Successful in 1m15s
Tests / Build and Test (3.13) (pull_request) Successful in 1m9s
Analysis / SonarCloud (push) Successful in 50s
2025-06-18 09:21:02 +03:00
edc3e0717d Update dependency tox to v4.27.0
All checks were successful
Tests / Build and Test (3.11) (pull_request) Successful in 1m22s
Tests / Build and Test (3.12) (pull_request) Successful in 1m30s
Tests / Build and Test (3.13) (pull_request) Successful in 1m40s
Analysis / SonarCloud (push) Successful in 1m1s
Analysis / SonarCloud (pull_request) Successful in 58s
2025-06-17 18:51:05 +03:00
d70fd4f491 Update dependency mypy to v1.16.1
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 58s
Tests / Build and Test (3.11) (pull_request) Successful in 1m17s
Tests / Build and Test (3.12) (pull_request) Successful in 1m16s
Tests / Build and Test (3.13) (pull_request) Successful in 1m10s
Analysis / SonarCloud (push) Successful in 1m9s
2025-06-16 20:06:16 +03:00
c4fb1dd5dd Update dependency pytest-cov to v6.2.1
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 53s
Tests / Build and Test (3.11) (pull_request) Successful in 1m20s
Tests / Build and Test (3.12) (pull_request) Successful in 1m19s
Tests / Build and Test (3.13) (pull_request) Successful in 1m12s
Analysis / SonarCloud (push) Successful in 1m1s
2025-06-12 13:57:08 +03:00
38bf43a5e7 Update dependency pytest-cov to v6.2.0
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 50s
Tests / Build and Test (3.11) (pull_request) Successful in 1m24s
Tests / Build and Test (3.12) (pull_request) Successful in 1m34s
Tests / Build and Test (3.13) (pull_request) Successful in 1m11s
Analysis / SonarCloud (push) Successful in 49s
2025-06-12 01:32:32 +03:00
5dff5fa71d Update dependency types-aiofiles to v24.1.0.20250606
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 49s
Tests / Build and Test (3.11) (pull_request) Successful in 1m14s
Tests / Build and Test (3.12) (pull_request) Successful in 1m10s
Tests / Build and Test (3.13) (pull_request) Successful in 1m8s
Analysis / SonarCloud (push) Successful in 50s
2025-06-06 06:11:29 +03:00
e596658c68 Update dependency pytest to v8.4.0
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 58s
Tests / Build and Test (3.11) (pull_request) Successful in 1m11s
Tests / Build and Test (3.12) (pull_request) Successful in 1m8s
Tests / Build and Test (3.13) (pull_request) Successful in 1m6s
Analysis / SonarCloud (push) Successful in 51s
2025-06-02 20:43:25 +03:00
1e1b04a8ff Update dependency typing-extensions to ~=4.14.0
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 58s
Tests / Build and Test (3.11) (pull_request) Successful in 1m19s
Tests / Build and Test (3.12) (pull_request) Successful in 1m11s
Tests / Build and Test (3.13) (pull_request) Successful in 1m9s
Analysis / SonarCloud (push) Successful in 1m7s
2025-06-02 18:39:15 +03:00
69b034c007 Update dependency mypy to v1.16.0
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 46s
Tests / Build and Test (3.11) (pull_request) Successful in 1m17s
Tests / Build and Test (3.12) (pull_request) Successful in 1m10s
Tests / Build and Test (3.13) (pull_request) Successful in 1m7s
Analysis / SonarCloud (push) Successful in 51s
2025-05-29 16:49:31 +03:00
kku
54de950899 Fixed compatibility issue with PEP 639
All checks were successful
Analysis / SonarCloud (push) Successful in 51s
2025-05-28 10:05:30 +02:00
c17a206c44 Update dependency redis to ~=6.2.0
Some checks failed
Analysis / SonarCloud (pull_request) Successful in 48s
Tests / Build and Test (3.11) (pull_request) Failing after 55s
Tests / Build and Test (3.12) (pull_request) Successful in 1m7s
Tests / Build and Test (3.13) (pull_request) Successful in 1m8s
Analysis / SonarCloud (push) Successful in 50s
2025-05-28 08:54:30 +03:00
dc05eb0ccb Update dependency pytest-asyncio to v1
Some checks failed
Analysis / SonarCloud (pull_request) Successful in 50s
Tests / Build and Test (3.11) (pull_request) Failing after 52s
Tests / Build and Test (3.12) (pull_request) Successful in 1m20s
Tests / Build and Test (3.13) (pull_request) Successful in 1m20s
Analysis / SonarCloud (push) Successful in 50s
2025-05-26 08:33:47 +03:00
3a7f748d96 Updated the license specification to comply with PEP 639
All checks were successful
Analysis / SonarCloud (push) Successful in 47s
2025-05-18 17:44:18 +02:00
95abf4265c Added support for cache prefix
All checks were successful
Analysis / SonarCloud (push) Successful in 54s
Analysis / SonarCloud (pull_request) Successful in 46s
Tests / Build and Test (3.11) (pull_request) Successful in 1m12s
Tests / Build and Test (3.12) (pull_request) Successful in 1m9s
Tests / Build and Test (3.13) (pull_request) Successful in 1m6s
2025-05-18 17:29:27 +02:00
84e1cf7ce9 Update dependency types-aiofiles to v24.1.0.20250516
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 41s
Tests / Build and Test (3.11) (pull_request) Successful in 1m9s
Tests / Build and Test (3.12) (pull_request) Successful in 1m9s
Tests / Build and Test (3.13) (pull_request) Successful in 1m7s
Analysis / SonarCloud (push) Successful in 48s
2025-05-16 06:49:57 +03:00
accd22dd4d Update dependency tox to v4.26.0
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 43s
Tests / Build and Test (3.11) (pull_request) Successful in 1m9s
Tests / Build and Test (3.12) (pull_request) Successful in 1m7s
Tests / Build and Test (3.13) (pull_request) Successful in 1m4s
Analysis / SonarCloud (push) Successful in 46s
2025-05-13 18:09:36 +03:00
e296aaa6b3 Update dependency redis to ~=6.1.0
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 1m39s
Tests / Build and Test (3.11) (pull_request) Successful in 1m19s
Tests / Build and Test (3.12) (pull_request) Successful in 1m26s
Tests / Build and Test (3.13) (pull_request) Successful in 1m18s
Analysis / SonarCloud (push) Successful in 49s
2025-05-13 16:06:05 +03:00
6de12244ec Update dependency pylint to v3.3.7
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 45s
Tests / Build and Test (3.11) (pull_request) Successful in 1m9s
Tests / Build and Test (3.12) (pull_request) Successful in 1m8s
Tests / Build and Test (3.13) (pull_request) Successful in 1m9s
Analysis / SonarCloud (push) Successful in 53s
2025-05-04 20:55:27 +03:00
e45266a977 Update dependency redis to v6
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 44s
Tests / Build and Test (3.11) (pull_request) Successful in 1m7s
Tests / Build and Test (3.12) (pull_request) Successful in 1m6s
Tests / Build and Test (3.13) (pull_request) Successful in 1m6s
Analysis / SonarCloud (push) Successful in 48s
2025-04-30 22:28:51 +03:00
9f1179f330 Update dependency redis to ~=5.3.0
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 1m36s
Tests / Build and Test (3.11) (pull_request) Successful in 1m23s
Tests / Build and Test (3.12) (pull_request) Successful in 1m23s
Tests / Build and Test (3.13) (pull_request) Successful in 1m22s
Analysis / SonarCloud (push) Successful in 53s
2025-04-30 18:22:21 +03:00
0690a0fe22 Update dependency pytest-cov to v6.1.1
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 39s
Tests / Build and Test (3.11) (pull_request) Successful in 1m10s
Tests / Build and Test (3.12) (pull_request) Successful in 1m8s
Tests / Build and Test (3.13) (pull_request) Successful in 1m5s
Analysis / SonarCloud (push) Successful in 51s
2025-04-05 17:22:39 +03:00
74f5d638e3 Update dependency pytest-cov to v6.1.0
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 39s
Tests / Build and Test (3.11) (pull_request) Successful in 1m11s
Tests / Build and Test (3.12) (pull_request) Successful in 1m6s
Tests / Build and Test (3.13) (pull_request) Successful in 1m5s
Analysis / SonarCloud (push) Successful in 1m38s
2025-04-01 14:38:36 +03:00
809e103aa3 Merge pull request 'Update dependency tox to v4.25.0' (#198) from renovate/tox-4.x into dev
All checks were successful
Analysis / SonarCloud (push) Successful in 46s
Reviewed-on: #198
2025-03-27 17:57:47 +02:00
6171dac7b8 Update dependency tox to v4.25.0
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 39s
Tests / Build and Test (3.11) (pull_request) Successful in 1m9s
Tests / Build and Test (3.12) (pull_request) Successful in 1m7s
Tests / Build and Test (3.13) (pull_request) Successful in 1m4s
2025-03-27 17:30:45 +02:00
b7f847752c Update dependency types-ujson to v5.10.0.20250326
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 42s
Tests / Build and Test (3.11) (pull_request) Successful in 1m12s
Tests / Build and Test (3.12) (pull_request) Successful in 1m5s
Tests / Build and Test (3.13) (pull_request) Successful in 1m3s
Analysis / SonarCloud (push) Successful in 49s
2025-03-26 07:32:40 +02:00
cb5e6c7bdb Update dependency typing-extensions to ~=4.13.0
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 38s
Tests / Build and Test (3.11) (pull_request) Successful in 1m11s
Tests / Build and Test (3.12) (pull_request) Successful in 1m8s
Tests / Build and Test (3.13) (pull_request) Successful in 1m4s
Analysis / SonarCloud (push) Successful in 49s
2025-03-26 06:30:43 +02:00
762c20a213 Update dependency types-aiofiles to v24.1.0.20250326
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 50s
Tests / Build and Test (3.11) (pull_request) Successful in 1m31s
Tests / Build and Test (3.12) (pull_request) Successful in 1m11s
Tests / Build and Test (3.13) (pull_request) Successful in 1m10s
Analysis / SonarCloud (push) Successful in 46s
2025-03-26 05:28:21 +02:00
e34cb7f4b1 Update dependency pytest-asyncio to v0.26.0
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 47s
Tests / Build and Test (3.11) (pull_request) Successful in 1m14s
Tests / Build and Test (3.12) (pull_request) Successful in 1m10s
Tests / Build and Test (3.13) (pull_request) Successful in 1m5s
Analysis / SonarCloud (push) Successful in 52s
2025-03-25 08:50:28 +02:00
7908d0b906 Update dependency pylint to v3.3.6
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 41s
Tests / Build and Test (3.11) (pull_request) Successful in 1m9s
Tests / Build and Test (3.12) (pull_request) Successful in 1m5s
Tests / Build and Test (3.13) (pull_request) Successful in 1m4s
Analysis / SonarCloud (push) Successful in 43s
2025-03-20 13:40:52 +02:00
cc41f4aa83 Update dependency pylint to v3.3.5
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 38s
Tests / Build and Test (3.11) (pull_request) Successful in 1m8s
Tests / Build and Test (3.12) (pull_request) Successful in 1m6s
Tests / Build and Test (3.13) (pull_request) Successful in 1m3s
Analysis / SonarCloud (push) Successful in 45s
2025-03-09 09:34:58 +02:00
f29a6e4896 Update dependency tox to v4.24.2
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 43s
Tests / Build and Test (3.11) (pull_request) Successful in 1m9s
Tests / Build and Test (3.12) (pull_request) Successful in 1m6s
Tests / Build and Test (3.13) (pull_request) Successful in 1m5s
Analysis / SonarCloud (push) Successful in 51s
2025-03-07 20:38:14 +02:00
2bb62373d6 Merge pull request 'Update dependency pytest to v8.3.5' (#190) from renovate/pytest-8.x into dev
All checks were successful
Analysis / SonarCloud (push) Successful in 46s
Reviewed-on: #190
2025-03-02 16:19:26 +02:00
0ee1c75031 Update dependency pytest to v8.3.5
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 42s
Tests / Build and Test (3.11) (pull_request) Successful in 1m7s
Tests / Build and Test (3.12) (pull_request) Successful in 1m5s
Tests / Build and Test (3.13) (pull_request) Successful in 1m2s
2025-03-02 15:25:02 +02:00
12f7cb6365 Added some basic tests for Cache
All checks were successful
Analysis / SonarCloud (push) Successful in 42s
Analysis / SonarCloud (pull_request) Successful in 49s
Tests / Build and Test (3.11) (pull_request) Successful in 1m18s
Tests / Build and Test (3.12) (pull_request) Successful in 1m9s
Tests / Build and Test (3.13) (pull_request) Successful in 1m6s
2025-02-16 17:16:05 +01:00
76ee24cd9e Added cache support
All checks were successful
Analysis / SonarCloud (push) Successful in 50s
2025-02-16 17:03:46 +01:00
6d56d9d0f9 Hopefully fixed a circular import
All checks were successful
Analysis / SonarCloud (push) Successful in 47s
2025-02-16 16:58:56 +01:00
554b522400 Added experimental cache support
All checks were successful
Analysis / SonarCloud (push) Successful in 51s
2025-02-16 16:45:22 +01:00
e9abed27f8 Removed caching action
All checks were successful
Analysis / SonarCloud (push) Successful in 52s
2025-02-09 18:55:26 +01:00
845a69491d Silly attempt to fix token issues
Some checks failed
Analysis / SonarCloud (push) Failing after 4s
2025-02-09 18:51:48 +01:00
df2b5efd88 Merge pull request 'Closes #187 and improves documentation' (#188) from bugfix/187 into dev
Some checks failed
Analysis / SonarCloud (push) Failing after 4s
Reviewed-on: #188
2025-02-09 19:41:30 +02:00
6b2be48052 Closes #187 and improves documentation
Some checks failed
Analysis / SonarCloud (pull_request) Failing after 5s
Tests / Build and Test (3.11) (pull_request) Successful in 1m16s
Tests / Build and Test (3.12) (pull_request) Successful in 1m9s
Tests / Build and Test (3.13) (pull_request) Successful in 1m7s
2025-02-09 18:40:30 +01:00
ad70648ea2 Update dependency mypy to v1.15.0
Some checks failed
Analysis / SonarCloud (pull_request) Failing after 4s
Tests / Build and Test (3.11) (pull_request) Successful in 1m6s
Tests / Build and Test (3.12) (pull_request) Successful in 1m4s
Tests / Build and Test (3.13) (pull_request) Successful in 1m0s
Analysis / SonarCloud (push) Failing after 4s
2025-02-05 06:31:00 +02:00
09b4d512a6 Merge pull request 'Update dependency pytest-asyncio to v0.25.3' (#184) from renovate/pytest-asyncio-0.x into dev
Some checks failed
Analysis / SonarCloud (push) Failing after 3s
Reviewed-on: #184
2025-01-29 10:48:23 +02:00
1473d34ca1 Merge pull request 'Update dependency black to v25' (#185) from renovate/black-25.x into dev
Some checks failed
Analysis / SonarCloud (push) Failing after 4s
Reviewed-on: #185
2025-01-29 10:43:45 +02:00
5fc8ae6a6e Update dependency black to v25
Some checks failed
Analysis / SonarCloud (pull_request) Failing after 4s
Tests / Build and Test (3.11) (pull_request) Successful in 1m9s
Tests / Build and Test (3.12) (pull_request) Successful in 1m5s
Tests / Build and Test (3.13) (pull_request) Successful in 1m4s
2025-01-29 06:29:48 +02:00
8562d7e84c Update dependency pytest-asyncio to v0.25.3
Some checks failed
Analysis / SonarCloud (pull_request) Failing after 4s
Tests / Build and Test (3.11) (pull_request) Successful in 1m19s
Tests / Build and Test (3.12) (pull_request) Successful in 1m20s
Tests / Build and Test (3.13) (pull_request) Successful in 1m18s
2025-01-28 21:04:58 +02:00
258b46d829 Update dependency pylint to v3.3.4
Some checks failed
Analysis / SonarCloud (pull_request) Failing after 4s
Tests / Build and Test (3.11) (pull_request) Successful in 1m12s
Tests / Build and Test (3.12) (pull_request) Successful in 1m7s
Tests / Build and Test (3.13) (pull_request) Successful in 1m6s
Analysis / SonarCloud (push) Failing after 4s
2025-01-28 15:50:37 +02:00
efec002667 Merge pull request 'Update dependency twine to v6.1.0' (#181) from renovate/twine-6.x into dev
Some checks failed
Analysis / SonarCloud (push) Failing after 3s
Reviewed-on: #181
2025-01-24 16:38:45 +02:00
475eaf9ff3 Update dependency twine to v6.1.0
Some checks failed
Analysis / SonarCloud (pull_request) Failing after 3s
Tests / Build and Test (3.11) (pull_request) Successful in 1m31s
Tests / Build and Test (3.12) (pull_request) Successful in 1m23s
Tests / Build and Test (3.13) (pull_request) Successful in 1m14s
2025-01-21 21:37:09 +02:00
0fcd9f2041 Merge pull request 'Update dependency tox to v4.24.0' (#179) from renovate/tox-4.x into dev
Some checks failed
Analysis / SonarCloud (push) Failing after 4s
Reviewed-on: #179
2025-01-21 21:12:20 +02:00
44d07dc56a Update dependency tox to v4.24.0
Some checks failed
Tests / Build and Test (3.11) (pull_request) Successful in 1m17s
Tests / Build and Test (3.13) (pull_request) Successful in 1m6s
Tests / Build and Test (3.12) (pull_request) Successful in 1m9s
Analysis / SonarCloud (pull_request) Failing after 4s
2025-01-21 20:32:47 +02:00
c5e83c17d3 Disabled pip cache for publish because dependencies are inline
All checks were successful
Analysis / SonarCloud (push) Successful in 42s
2025-01-10 11:23:35 +02:00
129cbd923b Updated cache path for tests
All checks were successful
Analysis / SonarCloud (push) Successful in 41s
2025-01-10 11:22:33 +02:00
1ca126829b Hopefully fixed caching
All checks were successful
Analysis / SonarCloud (push) Successful in 49s
2025-01-10 00:09:05 +01:00
974aebfd1a Bruh, works exactly as bad. I give up... Let's cache this shit.
Some checks failed
Analysis / SonarCloud (push) Has been cancelled
2025-01-09 23:08:09 +01:00
ed7fa50dbd SonarQube works like shit, switching back to the old SonarCloud action
All checks were successful
Analysis / SonarCloud (push) Successful in 9m49s
2025-01-09 22:54:21 +01:00
82542de0bb SonarQube doesn't seem to work, one more try with latest
Some checks failed
Analysis / SonarCloud (push) Has been cancelled
2025-01-09 22:40:32 +01:00
9021eac87b SonarCloud action is deprecated, replacing with sonarqube one and returning to ubuntu-24.04
Some checks failed
Analysis / SonarCloud (push) Has been cancelled
2025-01-09 22:35:53 +01:00
651022ab6e SonarCloud doesn't like 22.04 either, trying ubuntu-latest instead
Some checks failed
Analysis / SonarCloud (push) Has been cancelled
2025-01-09 22:33:38 +01:00
f8c6b782a1 SonarCloud doesn't like 24.04, trying 22.04 instead
Some checks failed
Analysis / SonarCloud (push) Has been cancelled
2025-01-09 22:32:24 +01:00
a1d0b98858 Replaced ubuntu-latest with ubuntu-24.04
Some checks failed
Analysis / SonarCloud (push) Has been cancelled
2025-01-09 22:18:57 +01:00
fec40b1c44 Update dependency pytest-asyncio to v0.25.2
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 34s
Tests / Build and Test (3.11) (pull_request) Successful in 1m15s
Tests / Build and Test (3.12) (pull_request) Successful in 1m21s
Tests / Build and Test (3.13) (pull_request) Successful in 1m20s
Analysis / SonarCloud (push) Successful in 46s
2025-01-08 08:41:33 +02:00
646229d919 Added an index for the Sphinx builder 2025-01-05 22:57:08 +01:00
48fffb82ce Added basic files for the Sphinx builder 2025-01-05 22:48:15 +01:00
29a90fc385 WIP: Convert docstrings to Google's format 2025-01-05 22:46:40 +01:00
4777b3dc41 Added requirements for Sphinx 2025-01-04 17:45:31 +01:00
kku
e9b9fc6ca1 TEST: Publishing Action
All checks were successful
Analysis / SonarCloud (push) Successful in 46s
Analysis / SonarCloud (pull_request) Successful in 41s
Tests / Build and Test (3.11) (pull_request) Successful in 1m19s
Tests / Build and Test (3.12) (pull_request) Successful in 1m24s
Tests / Build and Test (3.13) (pull_request) Successful in 1m24s
2025-01-02 13:58:23 +01:00
1da367ccb1 Update dependency pytest-asyncio to v0.25.1
All checks were successful
Analysis / SonarCloud (push) Successful in 41s
Analysis / SonarCloud (pull_request) Successful in 40s
Tests / Build and Test (3.11) (pull_request) Successful in 1m15s
Tests / Build and Test (3.12) (pull_request) Successful in 1m22s
Tests / Build and Test (3.13) (pull_request) Successful in 1m22s
2025-01-02 08:03:07 +02:00
kku
d5e390fe66 Optimized json_load usage, imports and typing
All checks were successful
Analysis / SonarCloud (push) Successful in 48s
Analysis / SonarCloud (pull_request) Successful in 39s
Tests / Build and Test (3.11) (pull_request) Successful in 1m22s
Tests / Build and Test (3.12) (pull_request) Successful in 1m27s
Tests / Build and Test (3.13) (pull_request) Successful in 1m29s
2025-01-01 22:34:38 +01:00
kku
ae54bd5cce Bump version to 4.0.2
All checks were successful
Analysis / SonarCloud (push) Successful in 42s
Analysis / SonarCloud (pull_request) Successful in 39s
Tests / Build and Test (3.11) (pull_request) Successful in 1m19s
Tests / Build and Test (3.12) (pull_request) Successful in 1m22s
Tests / Build and Test (3.13) (pull_request) Successful in 1m23s
2024-12-31 11:16:16 +01:00
kku
9ce251d733 Added a quick README for examples (belongs to #60)
All checks were successful
Analysis / SonarCloud (push) Successful in 41s
2024-12-31 11:10:06 +01:00
kku
5dd873d683 Closes #61
All checks were successful
Analysis / SonarCloud (push) Successful in 1m1s
2024-12-31 11:07:24 +01:00
b47bcbe513 Update dependency mypy to v1.14.1
All checks were successful
Analysis / SonarCloud (pull_request) Successful in 35s
Tests / Build and Test (3.11) (pull_request) Successful in 1m14s
Tests / Build and Test (3.12) (pull_request) Successful in 1m37s
Tests / Build and Test (3.13) (pull_request) Successful in 1m22s
Analysis / SonarCloud (push) Successful in 47s
2024-12-30 19:17:40 +02:00
kku
bbbec75f91 Fixed naming conventions
All checks were successful
Analysis / SonarCloud (push) Successful in 44s
2024-12-29 19:27:42 +01:00
kku
94553b602e Fixed imports in examples 2024-12-29 16:27:58 +01:00
38 changed files with 953 additions and 269 deletions

View File

@@ -6,19 +6,18 @@ on:
- main
- dev
pull_request:
types: [opened, synchronize, reopened]
types: [ opened, synchronize, reopened ]
jobs:
sonarcloud:
name: SonarCloud
runs-on: ubuntu-latest
container: catthehacker/ubuntu:act-latest
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: SonarCloud Scan
uses: SonarSource/sonarcloud-github-action@master
- name: SonarQube Scan
uses: SonarSource/sonarqube-scan-action@v4.2.1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

View 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 }}

View File

@@ -11,18 +11,18 @@ on:
jobs:
test:
name: Build and Test
runs-on: ubuntu-latest
container: catthehacker/ubuntu:act-latest
runs-on: ubuntu-24.04
strategy:
matrix:
python-version: [ "3.11", "3.12", "3.13" ]
steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v3
with:
python-version: ${{ matrix.python-version }}
cache: 'pip'
cache-dependency-path: './requirements/*'
env:
AGENT_TOOLSDIRECTORY: /opt/hostedtoolcache
- name: Install dependencies

View File

@@ -16,6 +16,7 @@ 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.
@@ -36,6 +37,8 @@ pip install libbot[pycord,speed]
### Pyrogram
```python
import sys
from libbot.pyrogram.classes import PyroClient
@@ -47,7 +50,7 @@ def main():
except KeyboardInterrupt:
print("Shutting down...")
finally:
exit()
sys.exit()
if __name__ == "__main__":
@@ -57,6 +60,9 @@ if __name__ == "__main__":
### Pycord
```python
import asyncio
from asyncio import AbstractEventLoop
from discord import Intents
from libbot.utils import config_get
from libbot.pycord.classes import PycordBot
@@ -76,7 +82,7 @@ async def main():
if __name__ == "__main__":
loop = asyncio.get_event_loop()
loop: AbstractEventLoop = asyncio.get_event_loop()
loop.run_until_complete(main())
```

20
docs/Makefile Normal file
View File

@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

61
docs/conf.py Normal file
View File

@@ -0,0 +1,61 @@
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
import os
import sys
from datetime import datetime
from typing import List, Dict, Any
import libbot
sys.path.insert(0, os.path.abspath(".."))
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project: str = "LibBotUniversal"
author: str = libbot.__author__
version: str = libbot.__version__
release: str = version
copyright: str = f"{datetime.now().year} {author}"
html_title: str = f"{project} v{version} Documentation"
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions: List[str] = [
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.viewcode",
"sphinx.ext.viewcode",
"sphinx.ext.napoleon",
"sphinx_copybutton",
]
templates_path: List[str] = ["_templates"]
exclude_patterns: List[str] = ["_build", "Thumbs.db", ".DS_Store"]
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme: str = "furo"
html_static_path: List[str] = ["_static"]
html_theme_options: Dict[str, Any] = {
"source_repository": "https://git.end-play.xyz/profitroll/LibBotUniversal",
"source_branch": "main",
"source_directory": "docs/",
"light_css_variables": {
"font-stack": "'Outfit', sans-serif",
},
}
resource_links: Dict[str, Any] = {
"issues": "https://git.end-play.xyz/profitroll/LibBotUniversal/issues",
"examples": "https://git.end-play.xyz/profitroll/LibBotUniversal/tree/main/examples",
}

29
docs/index.rst Normal file
View File

@@ -0,0 +1,29 @@
Welcome to LibBotUniversal
=============================
LibBotUniversal (AKA libbot) simplifies development and maintenance of different chatbots.
Getting started
*****************************
There are a few pages to take a look at if you're just getting started.
* Installing the library
* Creating your first bot
* Examples of different bots
Getting help
*****************************
If you are looking for help or want to report a bug, we got you covered.
* Bug reports are being submitted on the repo's issue tracker.
Package
*****************************
.. toctree::
:maxdepth: 1
:caption: API reference
modules

35
docs/make.bat Normal file
View File

@@ -0,0 +1,35 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=_build
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.https://www.sphinx-doc.org/
exit /b 1
)
if "%1" == "" goto help
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd

7
docs/modules.rst Normal file
View File

@@ -0,0 +1,7 @@
libbot
======
.. toctree::
:maxdepth: 5
libbot

4
examples/README.md Normal file
View 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.

View File

@@ -1,5 +1,5 @@
[build-system]
requires = ["setuptools>=62.6", "wheel"]
requires = ["setuptools>=77.0.3", "wheel"]
build-backend = "setuptools.build_meta"
[project]
@@ -9,11 +9,11 @@ authors = [{ name = "Profitroll" }]
description = "Universal bot library with functions needed for basic Discord/Telegram bot development."
readme = "README.md"
requires-python = ">=3.11"
license = { text = "GPLv3" }
license = "GPL-3.0"
license-files = ["LICENSE"]
classifiers = [
"Development Status :: 3 - Alpha",
"Intended Audience :: Developers",
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
@@ -28,9 +28,11 @@ dependencies = { file = "requirements/_.txt" }
[tool.setuptools.dynamic.optional-dependencies]
dev = { file = "requirements/dev.txt" }
docs = { file = "requirements/docs.txt" }
pycord = { file = "requirements/pycord.txt" }
pyrogram = { file = "requirements/pyrogram.txt" }
speed = { file = "requirements/speed.txt" }
cache = { file = "requirements/cache.txt" }
[project.urls]
Source = "https://git.end-play.xyz/profitroll/LibBotUniversal"

View File

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

2
requirements/cache.txt Normal file
View File

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

View File

@@ -1,12 +1,12 @@
black==24.10.0
black==25.1.0
build==1.2.2.post1
isort==5.13.2
mypy==1.14.0
pylint==3.3.3
pytest-asyncio==0.25.0
pytest-cov==6.0.0
pytest==8.3.4
tox==4.23.2
twine==6.0.1
types-aiofiles==24.1.0.20241221
types-ujson==5.10.0.20240515
mypy==1.16.1
pylint==3.3.7
pytest-asyncio==1.0.0
pytest-cov==6.2.1
pytest==8.4.1
tox==4.27.0
twine==6.1.0
types-aiofiles==24.1.0.20250708
types-ujson==5.10.0.20250326

3
requirements/docs.txt Normal file
View File

@@ -0,0 +1,3 @@
furo==2024.8.6
sphinx==8.1.3
sphinx_copybutton==0.5.2

View File

@@ -1,4 +1,4 @@
__version__ = "4.0.1"
__version__ = "4.3.0"
__license__ = "GPL3"
__author__ = "Profitroll"

2
src/libbot/cache/__init__.py vendored Normal file
View 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
View 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
View 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

View 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, default_ttl_seconds=default_ttl_seconds), prefix=prefix)
def _get_prefixed_key(self, key: str) -> str:
return key if self.prefix is None else f"{self.prefix}_{key}"
def get_json(self, key: str) -> Any | None:
key = self._get_prefixed_key(key)
try:
result: Any | None = self.client.get(key, None)
logger.debug(
"Got json cache key '%s'%s",
key,
"" if result is not None else " (not found)",
)
except Exception as exc:
logger.error("Could not get json cache key '%s' due to: %s", key, exc)
return None
return None if result is None else _string_to_json(result)
def get_string(self, key: str) -> str | None:
key = self._get_prefixed_key(key)
try:
result: str | None = self.client.get(key, None)
logger.debug(
"Got string cache key '%s'%s",
key,
"" if result is not None else " (not found)",
)
return result
except Exception as exc:
logger.error("Could not get string cache key '%s' due to: %s", key, exc)
return None
# TODO Implement binary deserialization
def get_object(self, key: str) -> Any | None:
raise NotImplementedError()
def set_json(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
key = self._get_prefixed_key(key)
try:
self.client.set(
key,
_json_to_string(value),
expire=self.default_ttl_seconds if ttl_seconds is None else ttl_seconds,
)
logger.debug("Set json cache key '%s'", key)
except Exception as exc:
logger.error("Could not set json cache key '%s' due to: %s", key, exc)
return None
def set_string(self, key: str, value: str, ttl_seconds: Optional[int] = None) -> None:
key = self._get_prefixed_key(key)
try:
self.client.set(
key, value, expire=self.default_ttl_seconds if ttl_seconds is None else ttl_seconds
)
logger.debug("Set string cache key '%s'", key)
except Exception as exc:
logger.error("Could not set string cache key '%s' due to: %s", key, exc)
return None
# TODO Implement binary serialization
def set_object(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
raise NotImplementedError()
def delete(self, key: str) -> None:
key = self._get_prefixed_key(key)
try:
self.client.delete(key)
logger.debug("Deleted cache key '%s'", key)
except Exception as exc:
logger.error("Could not delete cache key '%s' due to: %s", key, exc)

110
src/libbot/cache/classes/cache_redis.py vendored Normal file
View 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
View File

@@ -0,0 +1 @@
from .manager import create_cache_client

37
src/libbot/cache/manager/manager.py vendored Normal file
View 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
View File

42
src/libbot/cache/utils/_objects.py vendored Normal file
View 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

View File

@@ -4,8 +4,8 @@ from typing import Any, List, Optional
class ConfigKeyError(Exception):
"""Raised when config key is not found.
### Attributes:
* key (`str | List[str]`): Missing config key.
Args:
key (str | List[str]): Missing config key
"""
def __init__(self, key: str | List[str]) -> None:
@@ -21,9 +21,9 @@ class ConfigKeyError(Exception):
class ConfigValueError(Exception):
"""Raised when config key's value is invalid.
### Attributes:
* key (`str | List[str]`): Invalid config key.
* value (`Optional[Any]`): Key's correct value.
Args:
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:

View File

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

View File

@@ -14,6 +14,11 @@ class BotLocale:
default_locale: str | None = "en",
locales_root: str | Path = Path("locale"),
) -> None:
"""
Args:
default_locale (str | None): Default bot's locale. Defaults to `"en"`
locales_root (str | Path): Folder where locales are located. Defaults to `Path("locale")`
"""
if isinstance(locales_root, str):
locales_root = Path(locales_root)
elif not isinstance(locales_root, Path):
@@ -30,15 +35,15 @@ class BotLocale:
self.locales[locale] = json_read(Path(f"{locales_root}/{locale}.json"))
def _(self, key: str, *args: str, locale: str | None = None) -> Any:
"""Get value of locale string
"""Get value of locale string.
### Args:
* key (`str`): The last key of the locale's keys path
* *args (`str`): Path to key like: `dict[args][key]`
* locale (`str | None`, *optional*): Locale to looked up in. Defaults to config's `"locale"` value
Args:
key (str): The last key of the locale's keys path
*args (str): Path to key like: `dict[args][key]`
locale (str | None, optional): Locale to be looked up in. Defaults to config's `"locale"` value
### Returns:
* `Any`: Value of provided locale key. Is usually `str`, `Dict[str, Any]` or `List[Any]`
Returns:
Any: Value of provided locale key. Is usually `str`, `Dict[str, Any]` or `List[Any]`
"""
if locale is None:
locale: str = self.default
@@ -64,14 +69,14 @@ class BotLocale:
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
def in_all_locales(self, key: str, *args: str) -> List[Any]:
"""Get value of the provided key and path in all available locales
"""Get value of the provided key and path in all available locales.
### Args:
* key (`str`): The last key of the locale's keys path.
* *args (`str`): Path to key like: `dict[args][key]`.
Args:
key (str): The last key of the locale's keys path
*args (str): Path to key like: `dict[args][key]`
### Returns:
* `List[Any]`: List of values in all locales
Returns:
List[Any]: List of values in all locales
"""
output: List[Any] = []
@@ -94,14 +99,14 @@ class BotLocale:
return output
def in_every_locale(self, key: str, *args: str) -> Dict[str, Any]:
"""Get value of the provided key and path in every available locale with locale tag
"""Get value of the provided key and path in every available locale with locale tag.
### Args:
* key (`str`): The last key of the locale's keys path.
* *args (`str`): Path to key like: `dict[args][key]`.
Args:
key (str): The last key of the locale's keys path
*args (str): Path to key like: `dict[args][key]`
### Returns:
* `Dict[str, Any]`: Locale is a key, and it's value from locale file is a value
Returns:
Dict[str, Any]: Locale is a key, and it's value from locale file is a value
"""
output: Dict[str, Any] = {}

View File

@@ -1,9 +1,13 @@
import logging
from logging import Logger
from pathlib import Path
from typing import Any, Dict
from typing_extensions import override
from ...i18n.classes import BotLocale
from ...utils import json_read
try:
from apscheduler.schedulers.asyncio import AsyncIOScheduler
from apscheduler.schedulers.background import BackgroundScheduler
@@ -11,17 +15,11 @@ try:
except ImportError as 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 ...i18n.classes import BotLocale
logger = logging.getLogger(__name__)
logger: Logger = logging.getLogger(__name__)
class PycordBot(Bot):
# TODO Write a docstring
@override
def __init__(
self,
@@ -32,11 +30,17 @@ class PycordBot(Bot):
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
"""
Args:
*args:
config:
config_path:
locales_root:
scheduler:
**kwargs:
"""
self.config: Dict[str, Any] = config if config is not None else json_read(config_path)
super().__init__(
debug_guilds=(self.config["bot"]["debug_guilds"] if self.config["debug"] else None),
@@ -58,15 +62,30 @@ class PycordBot(Bot):
self.scheduler: AsyncIOScheduler | BackgroundScheduler | None = scheduler
# TODO Write a docstring
@override
async def start(self, token: str, reconnect: bool = True, scheduler_start: bool = True) -> None:
"""
Args:
token:
reconnect:
scheduler_start:
"""
if self.scheduler is not None and scheduler_start:
self.scheduler.start()
await super().start(token, reconnect=reconnect)
# TODO Write a docstring
@override
async def close(self, scheduler_shutdown: bool = True, scheduler_wait: bool = True) -> None:
"""
Args:
scheduler_shutdown:
scheduler_wait:
"""
if self.scheduler is not None and scheduler_shutdown:
self.scheduler.shutdown(scheduler_wait)

View File

@@ -0,0 +1 @@
from .color import color_from_hex, hex_from_color

View File

@@ -0,0 +1,39 @@
from discord import Colour
def _int_from_hex(hex_string: str) -> int:
try:
return int(hex_string, base=16)
except Exception as exc:
raise ValueError("Input string must be a valid HEX code.") from exc
def _hex_from_int(color_int: int) -> str:
if not 0 <= color_int <= 0xFFFFFF:
raise ValueError("Color's value must be in the range 0 to 0xFFFFFF.")
return f"#{color_int:06x}"
def color_from_hex(hex_string: str) -> Colour:
"""Convert valid hexadecimal string to :class:`discord.Colour`.
Args:
hex_string (str): Hexadecimal string to convert into :class:`discord.Colour` object
Returns:
Colour: :class:`discord.Colour` object
"""
return Colour(_int_from_hex(hex_string))
def hex_from_color(color: Colour) -> str:
"""Convert :class:`discord.Colour` to hexadecimal string.
Args:
color (Colour): :class:`discord.Colour` object to convert into the string
Returns:
str: Hexadecimal string in #XXXXXX format
"""
return _hex_from_int(color.value)

View File

@@ -2,13 +2,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
from typing import Any, Dict, List, Optional
from typing_extensions import override
from .command import PyroCommand
from .commandset import CommandSet
from ...i18n import _
from ...i18n.classes import BotLocale
from ...utils import json_read
try:
import pyrogram
from apscheduler.schedulers.asyncio import AsyncIOScheduler
@@ -35,15 +42,11 @@ try:
except ImportError:
from json import dumps, loads
from ...i18n.classes import BotLocale
from ...i18n import _
from .command import PyroCommand
from .commandset import CommandSet
logger = logging.getLogger(__name__)
logger: Logger = logging.getLogger(__name__)
class PyroClient(Client):
# TODO Write a docstring
@override
def __init__(
self,
@@ -66,11 +69,7 @@ class PyroClient(Client):
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,
@@ -121,6 +120,12 @@ class PyroClient(Client):
@override
async def start(self, register_commands: bool = True, scheduler_start: bool = True) -> None:
"""Start the bot and it's services.
Args:
register_commands (bool, optional): Register commands on start. Defaults to `True`
scheduler_start (bool, optional): Start the scheduler on start. Defaults to `True`
"""
await super().start()
self.start_time = time()
@@ -213,6 +218,13 @@ class PyroClient(Client):
async def stop(
self, exit_completely: bool = True, scheduler_shutdown: bool = True, scheduler_wait: bool = True
) -> None:
"""Stop the bot and it's services.
Args:
exit_completely (bool, optional): Exit the program. Defaults to `True`
scheduler_shutdown (bool): Shutdown the scheduler. Defaults to `True`
scheduler_wait (bool): Wait for tasks to finish. Defaults to `True`
"""
try:
await self.send_message(
chat_id=(
@@ -239,10 +251,10 @@ class PyroClient(Client):
raise SystemExit("Bot has been shut down, this is not an application error!") from exc
async def collect_commands(self) -> List[CommandSet] | None:
"""Gather list of the bot's commands
"""Gather list of the bot's commands.
### Returns:
* `List[CommandSet]`: List of the commands' sets.
Returns:
List[CommandSet]: List of the commands' sets
"""
command_sets = None
@@ -324,10 +336,10 @@ class PyroClient(Client):
self,
command: str,
) -> None:
"""Add command to the bot's internal commands list
"""Add command to the bot's internal commands list.
### Args:
* command (`str`)
Args:
command (str): Command's name
"""
self.commands.append(
PyroCommand(
@@ -340,9 +352,12 @@ class PyroClient(Client):
command,
)
async def register_commands(self, command_sets: List[CommandSet] | None = None) -> None:
"""Register commands stored in bot's 'commands' attribute"""
async def register_commands(self, command_sets: Optional[List[CommandSet]] = None) -> None:
"""Register commands stored in bot's 'commands' attribute.
Args:
command_sets (List[CommandSet], optional): List of command sets. Commands will be parsed from bot's 'commands' attribute if not provided
"""
if command_sets is None:
commands = [
BotCommand(command=command.command, description=command.description)
@@ -367,9 +382,12 @@ class PyroClient(Client):
language_code=command_set.language_code,
)
async def remove_commands(self, command_sets: List[CommandSet] | None = None) -> None:
"""Remove commands stored in bot's 'commands' attribute"""
async def remove_commands(self, command_sets: Optional[List[CommandSet]] = None) -> None:
"""Remove commands stored in bot's 'commands' attribute.
Args:
command_sets (List[CommandSet], optional): List of command sets. Commands with scope :class:`pyrogram.types.BotCommandScopeDefault` will be removed if not provided
"""
if command_sets is None:
logger.info("Removing commands with a default scope 'BotCommandScopeDefault'")
await self.delete_bot_commands(BotCommandScopeDefault())

View File

@@ -15,34 +15,24 @@ 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"`
"""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 (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
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
Returns:
Any: Key's value
### Example:
Get the "salary" of "Pete" from this JSON structure:
```json
{
"users": {
"Pete": {
"salary": 10.0
}
}
}
```
Example:
Get the "salary" of "Pete" from this JSON structure: `{"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 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)
@@ -54,34 +44,24 @@ def config_get(key: str, *path: str, config_file: str | Path = DEFAULT_CONFIG_LO
@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"`
"""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 (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
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
Returns:
Any: Key's value
### Example:
Get the "salary" of "Pete" from this JSON structure:
```json
{
"users": {
"Pete": {
"salary": 10.0
}
}
}
```
Example:
Get the "salary" of "Pete" from this JSON structure: `{"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 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)
@@ -93,16 +73,16 @@ async def config_get(key: str, *path: str, config_file: str | Path = DEFAULT_CON
@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
"""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 (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
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 is not found under path provided
Raises:
KeyError: Key was not found under the provided path.
"""
json_write(nested_set(json_read(config_file), value, *(*path, key)), config_file)
@@ -111,16 +91,16 @@ def config_set(key: str, value: Any, *path: str, config_file: str | Path = DEFAU
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
"""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 (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
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 is not found under path provided
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)
@@ -132,16 +112,16 @@ def config_delete(
missing_ok: bool = False,
config_file: str | Path = DEFAULT_CONFIG_LOCATION,
) -> None:
"""Set config's key by its path
"""Delete config's key by its path.
### Args:
* key (`str`): Key to delete
* *path (`str`): Path to the key of the target
* missing_ok (`bool`): Do not raise an exception if the key is missing. Defaults to `False`
* config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
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`
Raises:
KeyError: Key is not found under path provided and `missing_ok` is False.
"""
config_data: Dict[str, Any] = json_read(config_file)
@@ -161,16 +141,16 @@ async def config_delete(
missing_ok: bool = False,
config_file: str | Path = DEFAULT_CONFIG_LOCATION,
) -> None:
"""Set config's key by its path
"""Delete config's key by its path.
### Args:
* key (`str`): Key to delete
* *path (`str`): Path to the key of the target
* missing_ok (`bool`): Do not raise an exception if the key is missing. Defaults to `False`
* config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
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`
Raises:
KeyError: Key is not found under path provided and `missing_ok` is False.
"""
config_data: Dict[str, Any] = await json_read(config_file)

View File

@@ -14,13 +14,13 @@ except ImportError:
@asyncable
def json_read(path: str | Path) -> Any:
"""Read contents of a JSON file
"""Read contents of a JSON file and return it.
### Args:
* path (`str | Path`): Path-like object or path as a string
Args:
path (str | Path): Path-like object or path to the file as a string.
### Returns:
* `Any`: File contents
Returns:
Any: File contents.
"""
with open(str(path), mode="r", encoding="utf-8") as f:
data = f.read()
@@ -30,13 +30,13 @@ def json_read(path: str | Path) -> Any:
@json_read.asynchronous
async def json_read(path: str | Path) -> Any:
"""Read contents of a JSON file
"""Read contents of a JSON file and return it.
### Args:
* path (`str | Path`): Path-like object or path as a string
Args:
path (str | Path): Path-like object or path to the file as a string.
### Returns:
* `Any`: File contents
Returns:
Any: File contents.
"""
async with aiofiles.open(str(path), mode="r", encoding="utf-8") as f:
data = await f.read()
@@ -46,11 +46,11 @@ async def json_read(path: str | Path) -> Any:
@asyncable
def json_write(data: Any, path: str | Path) -> None:
"""Write contents to a JSON file
"""Write contents to a JSON file.
### Args:
* data (`Any`): Contents to write. Must be a JSON serializable
* path (`str | Path`): Path-like object or path as a string of a destination
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(
@@ -62,11 +62,11 @@ def json_write(data: Any, path: str | Path) -> None:
@json_write.asynchronous
async def json_write(data: Any, path: str | Path) -> None:
"""Write contents to a JSON file
"""Write contents to a JSON file.
### Args:
* data (`Any`): Contents to write. Must be a JSON serializable
* path (`str | Path`): Path-like object or path as a string of a destination
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(

View File

@@ -3,15 +3,15 @@ from typing import Any, Dict
from typing import Callable
def supports_argument(func: Callable, arg_name: str) -> bool:
"""Check whether a function has a specific argument
def supports_argument(func: Callable[..., Any], arg_name: str) -> bool:
"""Check whether a function has a specific argument.
### Args:
* func (`Callable`): Function to be inspected
* arg_name (`str`): Argument to be checked
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
Returns:
bool: True if argument is supported and False if not.
"""
if hasattr(func, "__code__"):
return arg_name in inspect.signature(func).parameters
@@ -24,61 +24,63 @@ def supports_argument(func: Callable, arg_name: str) -> bool:
return False
def nested_set(target: dict, value: Any, *path: str, create_missing=True) -> Dict[str, Any]:
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`): 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`
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 path provided
Raises:
KeyError: Key is not found under the provided path.
### Returns:
* `Dict[str, Any]`: Changed dictionary
Returns:
Dict[str, Any]: Modified dictionary.
"""
d = target
target_copy: Dict[str, Any] = target
for key in path[:-1]:
if key in d:
d = d[key]
if key in target_copy:
target_copy = target_copy[key]
elif create_missing:
d = d.setdefault(key, {})
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 d or create_missing:
d[path[-1]] = value
if path[-1] in target_copy or create_missing:
target_copy[path[-1]] = value
return target
def nested_delete(target: dict, *path: str) -> Dict[str, Any]:
"""Delete the key by its path
def nested_delete(target: Dict[str, Any], *path: str) -> Dict[str, Any]:
"""Delete the key by its path.
### Args:
* target (`dict`): Dictionary to perform modifications on
Args:
target (Dict[str, Any]): Dictionary to perform the modification on.
### Raises:
* `KeyError`: Key is not found under path provided
Raises:
KeyError: Key is not found under the provided path.
### Returns:
`Dict[str, Any]`: Changed dictionary
Returns:
Dict[str, Any]: Modified dictionary.
"""
d = target
target_copy: Dict[str, Any] = target
for key in path[:-1]:
if key in d:
d = d[key]
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 d:
del d[path[-1]]
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})")

View File

@@ -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"
}
}
}

28
tests/test_cache.py Normal file
View 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)

View File

@@ -10,13 +10,14 @@ python =
3.13: py313
[testenv]
setenv =
setenv =
PYTHONPATH = {toxinidir}
deps =
deps =
-r{toxinidir}/requirements/_.txt
-r{toxinidir}/requirements/dev.txt
-r{toxinidir}/requirements/pycord.txt
-r{toxinidir}/requirements/pyrogram.txt
-r{toxinidir}/requirements/speed.txt
-r{toxinidir}/requirements/cache.txt
commands =
pytest --basetemp={envtmpdir} --cov=libbot