Update docs

This commit is contained in:
Richard Chien
2019-01-26 22:21:51 +08:00
parent 00ff96aed0
commit e22e4a019f
53 changed files with 387 additions and 199 deletions

View File

@ -1,4 +1,8 @@
# 类 Shell 的参数解析
# 命令参数
## `session.get()` 和参数解析器
## 类 Shell 参数解析
`nonebot.argparse` 模块主要继承自 Python 内置的同名模块(`argparse`),用于解析命令的参数。在需要编写类 shell 语法的命令的时候,使用此模块可以大大提高开发效率。
@ -97,7 +101,7 @@ COMMAND
""".strip()
```
上面的例子出自 [cczu-osa/amadeus](https://github.com/cczu-osa/amadeus) 项目的计划任务插件,这里我们只关注前 15 行。
上面的例子出自 [cczu-osa/aki](https://github.com/cczu-osa/aki) 项目的计划任务插件,这里我们只关注前 15 行。
`on_command``shell_like=True` 参数告诉 NoneBot 这个命令需要使用类 shell 语法NoneBot 会自动添加命令参数解析器来使用 Python 内置的 `shlex` 包分割参数。分割后的参数被放在 `session.args['argv']`,可通过 `session.argv` 属性来快速获得。

View File

@ -0,0 +1 @@
# 命令组

View File

@ -0,0 +1,9 @@
# 命令会话
## 生命周期
## 状态数据
## 暂停、终止
## 切换上下文

View File

@ -0,0 +1 @@
# 数据库

View File

@ -1,5 +1,7 @@
# 部署
## 基本部署
NoneBot 所基于的 python-aiocqhttp 库使用的 web 框架是 Quart因此 NoneBot 的部署方法和 Quart 一致([Deploying Quart](https://pgjones.gitlab.io/quart/deployment.html))。
Quart 官方建议使用 Hypercorn 来部署,这需要一个 ASGI app 对象,在 NoneBot 中,可使用 `nonebot.get_bot().asgi` 获得 ASGI app 对象。
@ -29,3 +31,5 @@ hypercorn run:app
```
另外NoneBot 配置文件的 `DEBUG` 项默认为 `True`,在生产环境部署时请注意修改为 `False` 以提高性能。
## 使用 Docker Compose 与 酷Q 同时部署

View File

@ -1 +1,7 @@
# 大型应用的最佳实践
## 使用独立 Logger
## 项目结构
## 根据运行环境加载不同的配置

View File

@ -1 +1,5 @@
# 消息处理
## CQ 码和消息段
## Expression

View File

@ -1 +0,0 @@
# 会话