From e548a334f22551251c157d05d24affe6e1cb08a5 Mon Sep 17 00:00:00 2001 From: Richard Chien Date: Sat, 18 Aug 2018 23:24:57 +0800 Subject: [PATCH] Update docs --- .../guide/code/awesome-bot-1/requirements.txt | 1 + .../awesome-bot-2/awesome/plugins/weather.py | 34 +++++ docs/guide/code/awesome-bot-2/bot.py | 11 ++ docs/guide/code/awesome-bot-2/config.py | 7 + .../guide/code/awesome-bot-2/requirements.txt | 1 + docs/guide/getting-started.md | 2 - docs/guide/writing-commands.md | 137 +++++++++++++++++- 7 files changed, 190 insertions(+), 3 deletions(-) create mode 100644 docs/guide/code/awesome-bot-1/requirements.txt create mode 100644 docs/guide/code/awesome-bot-2/awesome/plugins/weather.py create mode 100644 docs/guide/code/awesome-bot-2/bot.py create mode 100644 docs/guide/code/awesome-bot-2/config.py create mode 100644 docs/guide/code/awesome-bot-2/requirements.txt diff --git a/docs/guide/code/awesome-bot-1/requirements.txt b/docs/guide/code/awesome-bot-1/requirements.txt new file mode 100644 index 00000000..7c593adb --- /dev/null +++ b/docs/guide/code/awesome-bot-1/requirements.txt @@ -0,0 +1 @@ +none-bot>=0.2.1 \ No newline at end of file diff --git a/docs/guide/code/awesome-bot-2/awesome/plugins/weather.py b/docs/guide/code/awesome-bot-2/awesome/plugins/weather.py new file mode 100644 index 00000000..990d1b18 --- /dev/null +++ b/docs/guide/code/awesome-bot-2/awesome/plugins/weather.py @@ -0,0 +1,34 @@ +from none import on_command, CommandSession + + +# on_command 装饰器将函数声明为一个命令处理器 +# 这里 weather 为命令的名字，同时允许使用别名「天气」「天气预报」「查天气」 +@on_command('weather', aliases=('天气', '天气预报', '查天气')) +async def weather(session: CommandSession): + # 从 Session 对象中获取城市名称（city），如果当前不存在，则询问用户 + city = session.get('city', prompt='你想查询哪个城市的天气呢？') + # 获取城市的天气预报 + weather_report = await get_weather_of_city(city) + # 向用户发送天气预报 + await session.send(weather_report) + + +# weather.args_parser 装饰器将函数声明为 weather 命令的参数解析器 +# 命令解析器用于将用户输入的参数解析成命令真正需要的数据 +@weather.args_parser +async def _(session: CommandSession): + # 去掉消息首尾的空白符 + stripped_arg = session.current_arg_text.strip() + if session.current_key: + # 如果当前正在向用户询问更多信息（本例中只有可能是要查询的城市），则直接赋值 + session.args[session.current_key] = stripped_arg + elif stripped_arg: + # 如果当前没有在询问，但用户已经发送了内容，则理解为要查询的城市 + # 这种情况通常是用户直接将城市名跟在命令名后面，作为参数传入 + session.args['city'] = stripped_arg + + +async def get_weather_of_city(city: str) -> str: + # 这里简单返回一个字符串 + # 实际应用中，这里应该调用返回真实数据的天气 API，并拼接成天气预报内容 + return f'{city}的天气是……' diff --git a/docs/guide/code/awesome-bot-2/bot.py b/docs/guide/code/awesome-bot-2/bot.py new file mode 100644 index 00000000..df6f9cd2 --- /dev/null +++ b/docs/guide/code/awesome-bot-2/bot.py @@ -0,0 +1,11 @@ +from os import path + +import none + +import config + +if __name__ == '__main__': + none.init(config) + none.load_plugins(path.join(path.dirname(__file__), 'awesome', 'plugins'), + 'awesome.plugins') + none.run() diff --git a/docs/guide/code/awesome-bot-2/config.py b/docs/guide/code/awesome-bot-2/config.py new file mode 100644 index 00000000..ccce361f --- /dev/null +++ b/docs/guide/code/awesome-bot-2/config.py @@ -0,0 +1,7 @@ +from none.default_config import * + +HOST = '0.0.0.0' +PORT = 8080 + +SUPERUSERS = {12345678} +COMMAND_START.add('') diff --git a/docs/guide/code/awesome-bot-2/requirements.txt b/docs/guide/code/awesome-bot-2/requirements.txt new file mode 100644 index 00000000..7c593adb --- /dev/null +++ b/docs/guide/code/awesome-bot-2/requirements.txt @@ -0,0 +1 @@ +none-bot>=0.2.1 \ No newline at end of file diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index 9eb07522..0f203766 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -7,8 +7,6 @@ 使用你最熟悉的编辑器或 IDE，创建一个名为 `bot.py` 的文件，内容如下： ```python -# bot.py - import none if __name__ == '__main__': diff --git a/docs/guide/writing-commands.md b/docs/guide/writing-commands.md index 08add077..6222872f 100644 --- a/docs/guide/writing-commands.md +++ b/docs/guide/writing-commands.md @@ -1,3 +1,138 @@ # 编写命令 -本章将以天气查询功能为例，教你如何编写自己的命令。 +本章将以一个天气查询插件为例，教你如何编写自己的命令。 + +::: tip 提示 +本章的完整代码可以在 [awesome-bot-2](https://github.com/richardchien/none-bot/tree/master/docs/guide/code/awesome-bot-2) 查看。 +::: + +## 创建插件目录 + +首先我们需要创建一个目录来存放插件，这个目录需要满足一些条件才能作为插件目录，首先，我们的代码能够比较容易访问到它，其次，它必须是一个能够以 Python 模块形式导入的路径（后面解释为什么），一个比较好的位置是项目目录中的 `awesome/plugins/`，创建好之后，我们的 `awesome-bot` 项目的目录结构如下： + +``` +awesome-bot +├── awesome +│ └── plugins +├── bot.py +└── config.py +``` + +接着在 `plugins` 目录中新建一个名为 `weather.py` 的 Python 文件，暂时留空，此时目录结构如下： + +``` +awesome-bot +├── awesome +│ └── plugins +│ └── weather.py +├── bot.py +└── config.py +``` + +## 加载插件 + +现在我们的插件目录已经有了一个空的 `weather.py`，实际上它已经可以被成为一个插件了，尽管它还什么都没做。下面我们来让 NoneBot 加载这个插件，修改 `bot.py` 如下： + +```python {1,9-10} +from os import path + +import none + +import config + +if __name__ == '__main__': + none.init(config) + none.load_plugins(path.join(path.dirname(__file__), 'awesome', 'plugins'), + 'awesome.plugins') + none.run() +``` + +这里的重点在于 `none.load_plugins()` 函数的两个参数。第一个参数是插件目录的路径，这里根据 `bot.py` 的所在路径和相对路径拼接得到；第二个参数是导入插件模块时使用的模块名前缀，这个前缀要求必须是一个当前 Python 解释器可以导入的模块前缀，NoneBot 会在它后面加上插件的模块名共同组成完整的模块名来让解释器导入，因此这里我们传入 `awesome.plugins`，当运行 `bot.py` 的时候，Python 解释器就能够正确导入 `awesome.plugins.weather` 这个插件模块了。 + +尝试运行 `python bot.py`，可以看到日志输出了类似如下内容： + +``` +[2018-08-18 21:46:55,425 none] INFO: Succeeded to import "awesome.plugins.weather" +``` + +这表示 NoneBot 已经成功加载到了 `weather` 插件。 + +::: warning 注意 +如果你运行时没有输出成功导入插件的日志，请确保你的当前工作目录是在 `awesome-bot` 项目的主目录中。 + +如果仍然不行，尝试在先 `awesome-bot` 主目录中执行下面的命令： + +```bash +export PYTHONPATH=. # Linux / macOS +set PYTHONPATH=. # Windows +``` +::: + +## 编写真正的内容 + +好了，现在已经确保插件可以正确加载，我们可以开始编写命令的实际代码了。在 `weather.py` 中添加如下代码： + +```python +from none import on_command, CommandSession + + +# on_command 装饰器将函数声明为一个命令处理器 +# 这里 weather 为命令的名字，同时允许使用别名「天气」「天气预报」「查天气」 +@on_command('weather', aliases=('天气', '天气预报', '查天气')) +async def weather(session: CommandSession): + # 从 Session 对象中获取城市名称（city），如果当前不存在，则询问用户 + city = session.get('city', prompt='你想查询哪个城市的天气呢？') + # 获取城市的天气预报 + weather_report = await get_weather_of_city(city) + # 向用户发送天气预报 + await session.send(weather_report) + + +# weather.args_parser 装饰器将函数声明为 weather 命令的参数解析器 +# 命令解析器用于将用户输入的参数解析成命令真正需要的数据 +@weather.args_parser +async def _(session: CommandSession): + # 去掉消息首尾的空白符 + stripped_arg = session.current_arg_text.strip() + if session.current_key: + # 如果当前正在向用户询问更多信息（本例中只有可能是要查询的城市），则直接赋值 + session.args[session.current_key] = stripped_arg + elif stripped_arg: + # 如果当前没有在询问，但用户已经发送了内容，则理解为要查询的城市 + # 这种情况通常是用户直接将城市名跟在命令名后面，作为参数传入 + session.args['city'] = stripped_arg + + +async def get_weather_of_city(city: str) -> str: + # 这里简单返回一个字符串 + # 实际应用中，这里应该调用返回真实数据的天气 API，并拼接成天气预报内容 + return f'{city}的天气是……' +``` + +::: tip 提示 +从这里开始，你需要对 Python 的 asyncio 编程有所了解，因为 NoneBot 是完全基于 asyncio 的，具体可以参考 [廖雪峰的 Python 教程](https://www.liaoxuefeng.com/wiki/0014316089557264a6b348958f449949df42a6d3a2e542c000/00143208573480558080fa77514407cb23834c78c6c7309000)。 +::: + +为了简单起见，我们在这里的例子中没有接入真实的天气数据，但要接入也非常简单，你可以使用中国天气网、和风天气等网站提供的 API。 + +上面的代码中基本上每一行做了什么都在注释里写了，下面详细解释几个重要的地方。 + +要理解这段代码，我们要先单独看 6～13 行这个函数。首先，`session.get()` 函数调用尝试从当前 Session 对象中获取 `city` 这个参数，所有的参数都被存储在 `session.args` 变量（一个 `dict`）中，如果发现存在，则直接返回，并赋值给 `city` 变量，而如果 `city` 参数不存在，`session.get()` 会**中断**这次命令处理的流程，并保存当前会话（Session），然后向用户发送 `prompt` 参数的内容。这里的「中断」，意味着如果当前不存在 `city` 参数，第 9 行之后的代码将不会被执行，这是通过抛出异常做到的。 + +向用户发送 `prompt` 中的提示之后，会话会进入等待状态，此时我们称之为「当前用户正在 weather 命令的会话中」，当用户再次发送消息时，NoneBot 会唤起这个等待中的会话，并重新执行命令，也就是**从头开始**重新执行 6～13 行这个函数，如果用户在一定时间内（默认 5 分钟，可通过 `SESSION_EXPIRE_TIMEOUT` 配置项来更改）都没有再次跟机器人发消息，则会话因超时被关闭。 + +你可能想问了，既然是重新执行，那到第 9 行不还是会中断吗？这时候就需要参数解析器出场了，也就是 18～28 行这个函数。参数解析器的参数和命令处理函数一样，都是当前命令的 Session 对象，并且，它们会在命令处理函数之前执行，以确保正确解析参数以供后者使用。 + +上面的例子中，参数解析器会判断 `session.current_key` 是否为空，如果不为空，说明此前已经经历过「`session.get()` 发现所需参数不存在，然后提示用户输入」这个过程了，因为在这个过程中，`session.current_key` 会被赋值为所需的参数名字，在本例中是 `city`，于是，参数解析器将此刻的用户输入（`session.current_arg_text`，Session 的这个属性保存用户发送的消息中纯文本的部分）当做当前所需参数的值，赋值给 `session.args[session.current_key]`（之前提到，Session 中，参数保存在 `args` 属性）；相反，如果 `session.current_key` 为空，则表示目前还没有调用过 `session.get()`，而这个时候如果用户发送的消息中，存在命令参数，解析器会把它理解为要查询的城市名，赋值给 `session.args['city']`，此时用户发送的完整消息可能是这样的： + +``` +/查天气 南京 +``` + +现在我们已经理解完了天气命令的代码，是时候运行一下看看实际效果了，启动 NoneBot 后尝试向它分别发送上面这个带参数的消息和下面这个不带参数的消息： + +``` +/查天气 +``` + +观察看看有什么不同，以及它的回复是否符合我们对代码的理解。如果成功的话，此时你已经完成了一个**可交互的**天气查询命令的雏形，只需要再接入天气 API 就可以真正投入使用了！