nonebot/nonebot2
1
1
Fork 0
mirror of https://github.com/nonebot/nonebot2.git synced 2024-09-21 05:12:34 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

📝 Update scheduler.md

Browse Source
This commit is contained in:
Lan 2020-12-28 15:43:03 +08:00 committed by GitHub
parent 13fb2de964
commit 82abd2e6ce
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/advanced/scheduler.md
View File

@ -1,6 +1,8 @@
# 定时任务
本文撰写完成之时，`nonebot2` 已将 `APScheduler` 独立为 `nonebot_plugin_apscheduler` 插件，您可以在 [插件广场](https://v2.nonebot.dev/plugin-store.html) 中找到。
本文撰写完成之时，`nonebot2` 已将 `APScheduler` 独立为 `nonebot_plugin_apscheduler` 插件。
您可以在 [插件广场](https://v2.nonebot.dev/plugin-store.html) 中找到 `nonebot_plugin_apscheduler` 插件。
本文将以 `nonebot_plugin_apscheduler` 的 `README.md` 为基础，对 `nonebot2` 的定时任务实现提供指南。
@ -30,7 +32,9 @@ async def run_every_2_hour(arg1, arg2):
### 添加依赖 - 通过 poetry
我们推荐使用 `poetry` 实现虚拟环境和依赖管理，在 `nonebot2` 项目目录中执行以下命令以添加 `nonebot_plugin_apscheduler`
我们推荐使用 `poetry` 实现虚拟环境和依赖管理。
在 `nonebot2` 项目目录中执行以下命令以添加 `nonebot_plugin_apscheduler`
```bash
poetry add nonebot_plugin_apscheduler
@ -50,7 +54,9 @@ nb plugin install nonebot_plugin_apscheduler
为了使插件能够实现定时任务，需要先将 `scheduler` 对象传入插件
`nonebot2` 提供了 `nonebot.require()` 方法来实现 `nonebot2` 插件内容的传入，此处我们使用这个方法来传入 `scheduler` 对象
`nonebot2` 提供了 `nonebot.require()` 方法来实现 `nonebot2` 插件内容的传入。
此处我们使用这个方法来传入 `scheduler` 对象
> 使用该方法传入的插件本身也需要有对应实现，关于该方法的更多介绍可以参阅 [这里](https://v2.nonebot.dev/api/plugin.html#require-name)
@ -66,7 +72,9 @@ scheduler = require('nonebot_plugin_apscheduler').scheduler
### 向 .env.* 文件添加可选配置项
:::warning 注意 .env.* 文件的编写应遵循 nonebot2 对 .env.* 文件的编写要求 :::
:::warning 注意
.env.* 文件的编写应遵循 nonebot2 对 .env.* 文件的编写要求 :::
根据项目的 `.env` 文件设置，向 `.env.*` 文件添加 `nonebot_plugin_apscheduler` 的可选配置项
@ -88,4 +96,6 @@ apscheduler_autostart = true
apscheduler_config = {"apscheduler.timezone": "Asia/Shanghai"}
```
`nonebot_plugin_apscheduler` 提供了时区的默认值 `Asia/Shanghai`，增加其中配置项需要确保 `prefix: apscheduler.`
`nonebot_plugin_apscheduler` 提供了时区的默认值 `Asia/Shanghai`
增加其中配置项需要确保 `prefix: apscheduler.`