Session¶
你可以通过 Session 实现用户状态的记录。
一个简单的使用 Session 的 Demo
from werobot import WeRoBot
robot = WeRoBot(token=werobot.utils.generate_token())
@robot.text
def first(message, session):
if 'last' in session:
return
session['last'] = message.content
return message.content
robot.run()
开启/关闭 Session¶
Session 在 WeRoBot 中默认开启, 并使用 werobot.session.sqlitestorage.SQLiteStorage
作为存储后端。 如果想要更换存储后端, 可以修改 Config 中的 SESSION_STORAGE
from werobot import WeRoBot
from werobot.session.filestorage import FileStorage
robot = WeRoBot(token="token")
robot.config['SESSION_STORAGE'] = FileStorage()
如果想要关闭 Session 功能, 只需把 SESSION_STORAGE
设为 False 即可
from werobot import WeRoBot
robot = WeRoBot(token="token")
robot.config['SESSION_STORAGE'] = False
修改 Handler 以使用 Session¶
没有打开 Session 的时候,一个标准的 WeRoBot Handler 应该是这样的
@robot.text
def hello(message):
return "Hello!"
而在打开 Session 之后, 如果你的 handler 不需要使用 Session ,可以保持不变; 如果需要使用 Session ,则这个 Handler 需要修改为接受第二个参数: session
@robot.subscribe_event
def intro(message):
return "Hello!"
@robot.text
def hello(message, session):
count = session.get("count", 0) + 1
session["count"] = count
return "Hello! You have sent %s messages to me" % count
传入的 session
参数是一个标准的 Python 字典。
可用的 Session Storage¶
-
class
werobot.session.sqlitestorage.
SQLiteStorage
(filename='werobot_session.sqlite3')¶ SQLiteStorge 会把 Session 数据储存在一个 SQLite 数据库文件中
import werobot from werobot.session.sqlitestorage import SQLiteStorage session_storage = SQLiteStorage robot = werobot.WeRoBot(token="token", enable_session=True, session_storage=session_storage)
参数: filename – SQLite数据库的文件名, 默认是 werobot_session.sqlite3
-
class
werobot.session.mongodbstorage.
MongoDBStorage
(collection)¶ MongoDBStorage 会把你的 Session 数据储存在一个 MongoDB Collection 中
import pymongo import werobot from werobot.session.mongodbstorage import MongoDBStorage collection = pymongo.MongoClient()["wechat"]["session"] session_storage = MongoDBStorage(collection) robot = werobot.WeRoBot(token="token", enable_session=True, session_storage=session_storage)
你需要安装
pymongo
才能使用 MongoDBStorage 。参数: collection – 一个 MongoDB Collection。
-
class
werobot.session.redisstorage.
RedisStorage
(redis, prefix='ws_')¶ RedisStorage 会把你的 Session 数据储存在 Redis 中
import redis import werobot from werobot.session.redisstorage import RedisStorage db = redis.Redis() session_storage = RedisStorage(db, prefix="my_prefix_") robot = werobot.WeRoBot(token="token", enable_session=True, session_storage=session_storage)
你需要安装
redis
才能使用 RedisStorage 。参数: - redis – 一个 Redis Client。
- prefix – Reids 中 Session 数据 key 的 prefix 。默认为
ws_
-
class
werobot.session.saekvstorage.
SaeKVDBStorage
(prefix='ws_')¶ SaeKVDBStorage 使用SAE 的 KVDB 来保存你的session
import werobot from werobot.session.saekvstorage import SaeKVDBStorage session_storage = SaeKVDBStorage() robot = werobot.WeRoBot(token="token", enable_session=True, session_storage=session_storage)
需要先在后台开启 KVDB 支持
参数: prefix – KVDB 中 Session 数据 key 的 prefix 。默认为 ws_
-
class
werobot.session.filestorage.
FileStorage
(filename='werobot_session')¶ FileStorage 会把你的 Session 数据以 dbm 形式储存在文件中。
参数: filename – 文件名, 默认为 werobot_session