mirror of
				https://github.com/nonebot/nonebot2.git
				synced 2025-11-04 08:56:42 +00:00 
			
		
		
		
	💡 add scheduler docstring
This commit is contained in:
		@@ -76,6 +76,14 @@ module.exports = context => ({
 | 
			
		||||
                  title: "nonebot.typing 模块",
 | 
			
		||||
                  path: "typing"
 | 
			
		||||
                },
 | 
			
		||||
                {
 | 
			
		||||
                  title: "nonebot.config 模块",
 | 
			
		||||
                  path: "config"
 | 
			
		||||
                },
 | 
			
		||||
                {
 | 
			
		||||
                  title: "nonebot.sched 模块",
 | 
			
		||||
                  path: "sched"
 | 
			
		||||
                },
 | 
			
		||||
                {
 | 
			
		||||
                  title: "nonebot.log 模块",
 | 
			
		||||
                  path: "log"
 | 
			
		||||
@@ -83,10 +91,6 @@ module.exports = context => ({
 | 
			
		||||
                {
 | 
			
		||||
                  title: "nonebot.exception 模块",
 | 
			
		||||
                  path: "exception"
 | 
			
		||||
                },
 | 
			
		||||
                {
 | 
			
		||||
                  title: "nonebot.config 模块",
 | 
			
		||||
                  path: "config"
 | 
			
		||||
                }
 | 
			
		||||
              ]
 | 
			
		||||
            }
 | 
			
		||||
 
 | 
			
		||||
@@ -10,7 +10,13 @@
 | 
			
		||||
    * [nonebot.typing](typing.html)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
    * [nonebot.config](config.html)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
    * [nonebot.sched](sched.html)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
    * [nonebot.log](log.html)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
    * [nonebot.config](config.html)
 | 
			
		||||
    * [nonebot.exception](exception.html)
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										41
									
								
								docs/api/sched.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										41
									
								
								docs/api/sched.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,41 @@
 | 
			
		||||
---
 | 
			
		||||
contentSidebar: true
 | 
			
		||||
sidebarDepth: 0
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
# NoneBot.sched 模块
 | 
			
		||||
 | 
			
		||||
## 计划任务
 | 
			
		||||
 | 
			
		||||
计划任务使用第三方库 [APScheduler](https://github.com/agronholm/apscheduler) ,使用文档请参考 [APScheduler使用文档](https://apscheduler.readthedocs.io/en/latest/) 。
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
## `scheduler`
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
* **类型**
 | 
			
		||||
 | 
			
		||||
    `Optional[apscheduler.schedulers.asyncio.AsyncIOScheduler]`
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
* **说明**
 | 
			
		||||
 | 
			
		||||
    当可选依赖 `APScheduler` 未安装时,`scheduler` 为 None
 | 
			
		||||
 | 
			
		||||
    使用 `pip install nonebot[scheduler]` 安装可选依赖
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
* **常用示例**
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
```python
 | 
			
		||||
from nonebot 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")
 | 
			
		||||
```
 | 
			
		||||
@@ -24,7 +24,7 @@ pip install .
 | 
			
		||||
 | 
			
		||||
A task scheduling library for Python.
 | 
			
		||||
 | 
			
		||||
可用于定时任务,后台执行任务等
 | 
			
		||||
可用于计划任务,后台执行任务等
 | 
			
		||||
 | 
			
		||||
```bash
 | 
			
		||||
pip install nonebot2[scheduler]
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user