WeRoBot 0.2.0 微信公众号开发框架文档

• 语言: 英语
• 格式: .epub
• 来源: werobot.readthedocs.io

摘要

文档介绍了WeRoBot微信机器人框架的使用方法，包括如何创建最简单的Hello World程序，Handler的添加方式和消息处理逻辑，支持的消息类型（文本、图片、位置和未知消息），以及如何根据消息类型过滤和处理信息。文档还介绍了如何生成Token，返回不同类型的回复（文本和图文消息），以及对开发者贡献代码的要求。

AI总结

# WeRoBot 微信公众号开发框架文档总结

## 框架概述
WeRoBot 是一个基于 MIT 协议的微信机器人框架，用于微信公众号的开发。它提供了简单易用的接口和灵活的消息处理机制，帮助开发者快速构建微信机器人。

---

## 核心功能

### 1. **Hello World 示例**
- 最简单的实现是创建一个机器人，回复每条消息 "Hello World!"。
- 示例代码：

  import werobot
  robot = werobot.WeRoBot(token='tokenhere')
  @robot.handler
  def echo(message):
      return 'Hello World!'
  robot.run()

### 2. **Handlers（消息处理函数）**
- WeRoBot 会将合法请求依次发送给 `Handlers` 执行。
- 如果某个 Handler 返回非空值，后续 Handler 不会执行。
- 添加 Handler 的方式：
- 使用装饰器：

    @robot.handler
    def echo(message):
        return 'Hello World!'

- 使用 `add_handler` 方法：

    def echo(message):
        pass
    robot.add_handler(echo, types=['text', 'location'])

### 3. **Replies（回复类型）**
WeRoBot 提供两种主要的回复类型：
- **TextReply**：简单的文本消息，构造参数包括 `content`（正文）、`target`（目标用户）、`source`（来源用户）、`time`（时间戳）、`flag`（星标）。
- **ArticlesReply**：图文消息，支持添加最多 10 篇文章。每篇文章需通过 `Article` 类定义，参数包括 `title`（标题）、`description`（描述）、`img`（图片链接）、`url`（跳转链接）。

### 4. **Message（消息类型）**
WeRoBot 支持四种消息类型：
- **TextMessage**：文本消息，包含 `content` 属性。
- **ImageMessage**：图片消息，包含 `img` 属性。
- **LocationMessage**：地理位置消息，包含 `(纬度, 经度)` 元组。
- **UnknownMessage**：未知消息类型。

### 5. **消息过滤**
- 可通过装饰器指定 Handler 处理的消息类型：

  @robot.text  # 只处理文本消息
  def echo(message):
      return message.content

- 支持的消息类型包括：`text`、`image`、`location` 和 `unknown`。

---

## 其他功能

### 1. **Token 生成**
WeRoBot 提供 `werobot.utils.generate_token()` 方法生成合法的 Token。

### 2. **代码贡献**
- 欢迎贡献代码。
- 提交前需确保代码符合 PEP8 规范并通过 `flake8` 检测。
- 测试代码时可使用 `nosetests`。

### 3. **捐助**
- 如果愿意支持，可通过支付宝向 `whtsky#gmail.com`（替换 `#` 为 `@`）捐赠。

---

## 总结
WeRoBot 是一个功能强大的微信机器人框架，支持多种消息类型和灵活的消息处理机制，适合快速开发微信公众号机器人。其核心功能包括消息处理、回复生成、Token 生成以及代码贡献支持。