WeRoBot 0.2.0

Hello World

最简单的Hello World， 会给收到的每一条信息回复 Hello World

import werobot

robot = werobot.WeRoBot(token='tokenhere')

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

robot.run()

Handlers

WeRoBot会将合法的请求发送给handlers依次执行。

如果某一个Handler返回了非空值，WeRoBot就会根据这个值创建回复，后面的handlers将不会被执行。

你可以通过两种方式添加handler

import werobot

robot = werobot.WeRoBot(token='tokenhere')

# 通过修饰符添加handler
@robot.handler
def echo(message):
    return 'Hello World!'

# 通过`add_handler`添加handler
def echo(message):
    return 'Hello World!'
robot.add_handler(echo)

Messages

目前WeRoBot共有四种Message：TextMessage ， ImageMessage ， LocationMessage 和 UnknownMessage 。他们都继承自 WeChatMessage 。

TextMessage的属性：

ImageMessage的属性：

LocationMessage的属性：

UnknownMessage：

类型过滤

WeRoBot 一共有4类 Message ， 5种 type 。显然，一个 handler 不可能把这五种 type 都支持全。

幸运的是， WeRoBot 可以帮你过滤收到的消息。

只想处理被新用户关注的消息？:

import werobot

robot = werobot.WeRoBot(token='tokenhere')

@robot.hello
def hello(message):
    return 'Hello My Friend!'

robot.run()

或者，你的 handler 只能处理文本？

import werobot

robot = werobot.WeRoBot(token='tokenhere')

@robot.text
def echo(message):
    return message.content

robot.run()

你也可以使用 robot.image 修饰符来只接受图像信息； robot.location 修饰符来只接受位置信息。 当然，还有 robot.unknown —— 如果你想收到未知属性的信息的话。

额，这个 handler 想处理文本信息和地理位置信息？

import werobot

robot = werobot.WeRoBot(token='tokenhere')

@robot.text
@robot.location
def handler(message):
    # Do what you love to do
    pass

robot.run()

当然，你也可以用 add_handler 函数添加handler，就像这样:

import werobot

robot = werobot.WeRoBot(token='tokenhere')

def handler(message):
    # Do what you love to do
    pass

robot.add_handler(handler, types=['text', 'location'])

robot.run()

Replies

目前WeRoBot共有三种Reply： TextReply ， ArticlesReply 。他们都继承自 WeChatReply 。

TextReply 是简单的文本消息，构造函数的参数如下：

你可以在构建Reply时传入一个合法的 Message 类来自动生成 source 和 target

reply = TextReply(message=message, content='Hello!')

ArticlesReply 是图文消息，构造函数的参数如下：

你需要给 ArticlesReply 添加 Article 来增加图文。 Article 类位于 werobot.reply.Article 。

Article 的构造函数的参数如下：

注意，微信公众平台对图片链接有特殊的要求，详情可以在 消息接口使用指南 里看到。

在构造完一个 Article 后， 你需要通过 ArticlesReply 的 add_article 参数把它添加进去。就像这样：

from werobot.reply import ArticlesReply, Article
reply = ArticlesReply(message=message)
article = Article(
    title="WeRoBot",
    desription="WeRoBot是一个微信机器人框架",
    img="https://github.com/apple-touch-icon-144.png",
    url="https://github.com/whtsky/WeRoBot"
)
reply.add_article(article)

你也可以让你的 handler 返回一个列表， 里面每一个元素都是一个长度为四的列表或数组，

WeRoBot 会将其自动转为 ArticlesReply 。就像这样：

import werobot

robot = werobot.WeRoBot(token='tokenhere')

@robot.text
def articles(message):
    return [
        [
            "title",
            "description",
            "img",
            "url"
        ],
        [
            "whtsky",
            "I wrote WeRoBot",
            "https://secure.gravatar.com/avatar/0024710771815ef9b74881ab21ba4173?s=420",
            "http://whouz.com/"
        ]
    ]

robot.run()

不知道该用什么Token?

WeRoBot帮你准备了一个Token生成器：

import werobot.utils

print(werobot.utils.generate_token())

贡献代码

WeRoBot欢迎每个人贡献代码。

在提交Pull Request前请注意，我有pep8强迫症。。请确定自己的代码通过flake8检测。

另外，不能自动merge的和不能通过测试的代码不会被接受。你可以在安装nose（pip install nose）之后运行`nosetests`来进行测试。

捐助

Buy me a cup of coffee :)

Via Alipay（支付宝）

"whtsky#gmail.com".replace("#", "@")