https://github.com/nonebot/plugin-apscheduler
APScheduler Support for NoneBot2
https://github.com/nonebot/plugin-apscheduler
apscheduler cron nonebot-plugin nonebot2
Last synced: about 2 months ago
JSON representation
APScheduler Support for NoneBot2
- Host: GitHub
- URL: https://github.com/nonebot/plugin-apscheduler
- Owner: nonebot
- License: mit
- Created: 2020-12-01T11:00:00.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-03T08:05:24.000Z (9 months ago)
- Last Synced: 2024-10-29T23:34:58.648Z (7 months ago)
- Topics: apscheduler, cron, nonebot-plugin, nonebot2
- Language: Python
- Homepage: https://nonebot.dev/docs/best-practice/scheduler
- Size: 174 KB
- Stars: 83
- Watchers: 5
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NoneBot Plugin APScheduler
_✨ NoneBot APScheduler 定时任务插件 ✨_
## 使用方式
加载插件后使用 `require` 获取 `scheduler` 对象（请注意插件加载顺序）
```python
from nonebot import require
require("nonebot_plugin_apscheduler")
from nonebot_plugin_apscheduler import scheduler
@scheduler.scheduled_job("cron", hour="*/2", id="xxx", args=[1], kwargs={"arg2": 2})
async def run_every_2_hour(arg1, arg2):
pass
scheduler.add_job(run_every_day_from_program_start, "interval", days=1, id="xxx")
```
## 配置项
### apscheduler_autostart
是否自动启动 `scheduler`
### apscheduler_log_level
`int` 类型日志等级
- `WARNING` = `30` (默认)
- `INFO` = `20`
- `DEBUG` = `10` (只有在开启 nonebot 的 debug 模式才会显示 debug 日志)
### apscheduler_config
`apscheduler` 的相关配置。参考 [配置 scheduler](https://apscheduler.readthedocs.io/en/latest/userguide.html#scheduler-config), [配置参数](https://apscheduler.readthedocs.io/en/latest/modules/schedulers/base.html#apscheduler.schedulers.base.BaseScheduler)
配置需要包含 `prefix: apscheduler.`
默认配置：
```json
{ "apscheduler.timezone": "Asia/Shanghai" }
```