安装及导入 wxpy
安装 wxpy
pip install wxpy
导入 wxpy
import wxpy
登录微信
登录
bot = wxpy.Bot(cache_path=None,
console_qr=False, qr_path=None,
qr_callback=None, login_callback=None, logout_callback=None)
参数 | 说明 |
---|---|
cache_path | 设置当前会话的缓存路径,并开启缓存功能;为 None (默认) 则不开启缓存功能。开启缓存后可在短时间内避免重复扫码,缓存失效时会重新要求登陆。 设为 True 时,使用默认的缓存路径 ‘wxpy.pkl’ |
console_qr | 在终端中显示登陆二维码,需要安装 pillow 模块。可为整数(int),表示二维码单元格的宽度,通常为 2 (当被设为 True 时,也将在内部当作 2)。也可为负数,表示以反色显示二维码,适用于浅底深字的命令行界面。 例如: 在大部分 Linux 系统中可设为 True 或 2,而在macOS Terminal 的默认白底配色中,应设为 -2 |
qr_path | 保存二维码的路径 |
qr_callback | 获得二维码后的回调,可以用来定义二维码的处理方式,接收参数: uuid, status, qrcode |
login_callback | 登陆成功后的回调,若不指定,将进行清屏操作,并删除二维码文件 |
logout_callback | 登出时的回调 |
阻塞进程
在完成注册操作后,若没有其他操作,程序会因主线程执行完成而退出。 因此务必堵塞线程以保持监听状态。
wxpy 的 embed() 可在堵塞线程的同时,进入 Python 命令行。
wxpy.embed(shell=None, local=None, banner='')
参数 | 说明 |
---|---|
shell: str | 指定命令行类型,可设为 ‘ipython’,’bpython’,’python’,或它们的首字母; 若为 None,则按上述优先级进入首个可用的 Python 命令行。 |
local: dict | 设定本地变量环境,若为 None,则获取进入之前的变量环境。 |
banner: str | 设定欢迎内容,将在进入命令行后展示。 |
聊天对象
聊天对象
获取所有聊天对象
bot.chats(update=False)
参数 | 说明 |
---|---|
update | 是否更新 |
返回: 聊天对象合集
返回类型: wxpy.Chats
获取所有好友
bot.friends(update=False)
参数 | 说明 |
---|---|
update | 是否更新 |
返回:聊天对象合集
返回类型:wxpy.Chats
获取所有群聊
bot.groups(update=False, contact_only=False)
一些不活跃的群可能无法被获取到,可通过在群内发言,或修改群名称的方式来激活
参数 | 说明 |
---|---|
update | 是否更新 |
contact_only | 是否限于保存为联系人的群聊 |
返回:群聊合集
返回类型:wxpy.Groups
获取所有公众号
bot.mps(update=False)
参数 | 说明 |
---|---|
update | 是否更新 |
返回:聊天对象合集
返回类型:wxpy.Chats