itchat

https://github.com/littlecodersh/ItChat

itchat

Gitter py27 py35 English version

itchat是一个开源的微信个人号接口，使用python调用微信从未如此简单。

使用不到三十行的代码，你就可以完成一个能够处理所有信息的微信机器人。

当然，该api的使用远不止一个机器人，更多的功能等着你来发现，比如这些。

该接口与公众号接口itchatmp共享类似的操作方式，学习一次掌握两个工具。

如今微信已经成为了个人社交的很大一部分，希望这个项目能够帮助你扩展你的个人的微信号、方便自己的生活。

安装

可以通过本命令安装itchat：

pip install itchat

 

2017年后，新注册的微信基本登录不了网页版，itchat-uos版本利用统信UOS的网页版微信，可以让你绕过网页微信的登录限制。

你只需要执行下条命令便能复活itchat

pip install itchat-uos

然后再import itchat就可以使用了

此时会显示“桌面微信”而不是“网页微信”了



作者：迷迭香
链接：https://www.zhihu.com/question/396682840/answer/1987462884
来源：知乎
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
 

简单入门实例

有了itchat，如果你想要给文件传输助手发一条信息，只需要这样：

import itchat

itchat.auto_login()

itchat.send('Hello, filehelper', toUserName='filehelper')

如果你想要回复发给自己的文本消息，只需要这样：

import itchat

@itchat.msg_register(itchat.content.TEXT)
def text_reply(msg):
    return msg.text

itchat.auto_login()
itchat.run()

一些进阶应用可以在下面的开源机器人的源码和进阶应用中看到，或者你也可以阅览文档。

试一试

这是一个基于这一项目的开源小机器人，百闻不如一见，有兴趣可以尝试一下。

由于好友数量实在增长过快，自动通过好友验证的功能演示暂时关闭。

QRCode

截屏

file-autoreply login-page

进阶应用

特殊的字典使用方式

通过打印itchat的用户以及注册消息的参数，可以发现这些值都是字典。

但实际上itchat精心构造了相应的消息、用户、群聊、公众号类。

其所有的键值都可以通过这一方式访问：

@itchat.msg_register(TEXT)
def _(msg):
    # equals to print(msg['FromUserName'])
    print(msg.fromUserName)

属性名为键值首字母小写后的内容。

author = itchat.search_friends(nickName='LittleCoder')[0]
author.send('greeting, littlecoder!')

各类型消息的注册

通过如下代码，微信已经可以就日常的各种信息进行获取与回复。

import itchat, time
from itchat.content import *

@itchat.msg_register([TEXT, MAP, CARD, NOTE, SHARING])
def text_reply(msg):
    msg.user.send('%s: %s' % (msg.type, msg.text))

@itchat.msg_register([PICTURE, RECORDING, ATTACHMENT, VIDEO])
def download_files(msg):
    msg.download(msg.fileName)
    typeSymbol = {
        PICTURE: 'img',
        VIDEO: 'vid', }.get(msg.type, 'fil')
    return '@%s@%s' % (typeSymbol, msg.fileName)

@itchat.msg_register(FRIENDS)
def add_friend(msg):
    msg.user.verify()
    msg.user.send('Nice to meet you!')

@itchat.msg_register(TEXT, isGroupChat=True)
def text_reply(msg):
    if msg.isAt:
        msg.user.send(u'@%s\u2005I received: %s' % (
            msg.actualNickName, msg.text))

itchat.auto_login(True)
itchat.run(True)

命令行二维码

通过以下命令可以在登陆的时候使用命令行显示二维码：

itchat.auto_login(enableCmdQR=True)

部分系统可能字幅宽度有出入，可以通过将enableCmdQR赋值为特定的倍数进行调整：

# 如部分的linux系统，块字符的宽度为一个字符（正常应为两字符），故赋值为2
itchat.auto_login(enableCmdQR=2)

默认控制台背景色为暗色（黑色），若背景色为浅色（白色），可以将enableCmdQR赋值为负值：

itchat.auto_login(enableCmdQR=-1)

退出程序后暂存登陆状态

通过如下命令登陆，即使程序关闭，一定时间内重新开启也可以不用重新扫码。

itchat.auto_login(hotReload=True)

用户搜索

使用search_friends方法可以搜索用户，有四种搜索方式：

  1. 仅获取自己的用户信息
  2. 获取特定UserName的用户信息
  3. 获取备注、微信号、昵称中的任何一项等于name键值的用户
  4. 获取备注、微信号、昵称分别等于相应键值的用户

其中三、四项可以一同使用，下面是示例程序：

# 获取自己的用户信息，返回自己的属性字典
itchat.search_friends()
# 获取特定UserName的用户信息
itchat.search_friends(userName='@abcdefg1234567')
# 获取任何一项等于name键值的用户
itchat.search_friends(name='littlecodersh')
# 获取分别对应相应键值的用户
itchat.search_friends(wechatAccount='littlecodersh')
# 三、四项功能可以一同使用
itchat.search_friends(name='LittleCoder机器人', wechatAccount='littlecodersh')

关于公众号、群聊的获取与搜索在文档中有更加详细的介绍。

附件的下载与发送

itchat的附件下载方法存储在msg的Text键中。

发送的文件的文件名（图片给出的默认文件名）都存储在msg的FileName键中。

下载方法接受一个可用的位置参数（包括文件名），并将文件相应的存储。

@itchat.msg_register([PICTURE, RECORDING, ATTACHMENT, VIDEO])
def download_files(msg):
    msg.download(msg.fileName)
    itchat.send('@%s@%s' % (
        'img' if msg['Type'] == 'Picture' else 'fil', msg['FileName']),
        msg['FromUserName'])
    return '%s received' % msg['Type']

如果你不需要下载到本地，仅想要读取二进制串进行进一步处理可以不传入参数，方法将会返回图片的二进制串。

@itchat.msg_register([PICTURE, RECORDING, ATTACHMENT, VIDEO])
def download_files(msg):
    with open(msg.fileName, 'wb') as f:
        f.write(msg.download())

用户多开

使用如下命令可以完成多开的操作：

import itchat

newInstance = itchat.new_instance()
newInstance.auto_login(hotReload=True, statusStorageDir='newInstance.pkl')

@newInstance.msg_register(itchat.content.TEXT)
def reply(msg):
    return msg.text

newInstance.run()

退出及登陆完成后调用特定方法

登陆完成后的方法需要赋值在loginCallback中。

而退出后的方法需要赋值在exitCallback中。

import time

import itchat

def lc():
    print('finish login')
def ec():
    print('exit')

itchat.auto_login(loginCallback=lc, exitCallback=ec)
time.sleep(3)
itchat.logout()

若不设置loginCallback的值，则将会自动删除二维码图片并清空命令行显示。

常见问题与解答

Q: 如何通过这个包将自己的微信号变为控制器？

A: 有两种方式：发送、接受自己UserName的消息；发送接收文件传输助手（filehelper）的消息

Q: 为什么我发送信息的时候部分信息没有成功发出来？

A: 有些账号是天生无法给自己的账号发送信息的，建议使用filehelper代替。

 

一、课程介绍

本文最佳阅读方式为实验楼的会员课程，建议点击链接在实验楼内阅读。

1. 课程来源

关于itchat进一步使用的问题你可以在主页加入官方交流群也可以在课程下面向我提问。

课程在常见的三种系统中都可以进行操作，itchat建议使用可以安装的最新版本。

本课程通过聊天机器人为例，介绍如何使用Python完成微信的点对点信息交互。

2. 内容简介

  • 课程实现微信个人号聊天机器人
  • 通过自定义消息处理方法加入聊天功能

3. 课程知识点

本课程项目完成过程中将学习：

  • 微信消息的基本获取与处理
  • 微信消息的指定发送

其中将重点介绍微信消息的获取与处理。

二、实验环境

在终端中输入以下命令，完成微信的API包itchat的安装。

我们这里使用python3的环境（python2也是可行的）：

sudo pip3 install itchat --upgrade

通过该命令判断是否安装成功：

python3 -c "import itchat"

如果没有报错信息说明你已经将实验环境安装完成。

install

三、实验原理

通过微信的Python接口itchat获取微信消息。

将微信消息传输到机器人接口（这里以图灵为例），获取机器人的返回消息。

将返回消息返回给微信消息的发送人。

实现将微信个人号变为聊天机器人的目的。

四、实验步骤

0. 基础知识

为了照顾一些从未使用过Python的新用户与使用其他语言的用户，这里简单的讲一下以下的代码如何使用。

下面的每一段描述都给出了相应的测试代码，如果没有特殊说明这段代码可以这样使用：

打开桌面的Xfce终端，先将目录通过以下命令切到桌面。

cd Desktop

之后使用gedit编辑器编辑我们的主程序。

你也完全可以使用vim，会使用vim的话想必也知道这里应该输入什么命令了。

gedit test.py

最后将给出的代码复制进编辑器，保存并退出，使用如下命令就可以使用了。

python3 test.py

那么，就让我们开始正式进入Python操作微信的探索之旅吧。

1. 实现微信消息的获取

itchat的注册时根据类型注册的。

在获取相应类型的信息时会调用该函数。

我们现在只需要获取最简单的文本消息，那么只需要这样注册：

import itchat

@itchat.msg_register(itchat.content.TEXT)
def print_content(msg):
    print(msg['Text'])

itchat.auto_login()
itchat.run()

其中第三行即注册的操作，通过装饰符将print_content注册为处理文本消息的函数。

微信有各种类型的数据，例如图片、语音、名片、分享等，也对应不同的注册参数：

  • 图片对应itchat.content.PICTURE
  • 语音对应itchat.content.RECORDING
  • 名片对应itchat.content.CARD
  • 其余的这里就不一一列举，更具体的内容可以自行搜索itchat阅读文档

执行命令

python3 test.py

就可看到我们开始登陆微信：

login

扫码完成以后最基础的文本信息的接收就完成了，你可以尝试用他人的微信给自己发一条信息。

如果你不想要每次运行程序都扫码，可以在登陆命令中进行设置：

itchat.auto_login(hotReload=True)

2. 实现微信消息的发送

微信可以发送各类消息，文本、图片、文件等，不过我们现在只需要使用文本的发送。

其余的消息的发送有兴趣可以自行阅读。

itchat.send('Message Content', 'toUserName')

该发送消息的函数需要两个参数，消息的内容与接受者的UserName，即标识符。

那么我们试着向文件传输助手发送一条消息：

#coding=utf8
import itchat

itchat.auto_login(hotReload=True)

# 注意实验楼环境的中文输入切换
itchat.send(u'测试消息发送', 'filehelper')

打开手机看一下是否就完成了消息的发送。

保存代码后，执行命令：

python3 test.py

扫描登录后的效果如下：

send-hello

当然，还有一种更加快捷的回复方法就是在注册函数中直接回复。

例如下面的例子将会将文本消息原封不动的返回。

import itchat

@itchat.msg_register(itchat.content.TEXT)
def print_content(msg):
    return msg['Text']

itchat.auto_login()
itchat.run()

这种方式显然更加直观也更加简单（不需要输入接受者的UserName）

我们本次实践将会采用这种方式。

3. 实现最简单的与图灵机器人的交互

要做一个能够与人交流的机器人有很多种方法，最简单的莫过于使用他人提供的接口。

我们这里以图灵机器人为例，演示这一功能。

图灵机器人简单而言就是以一定的规则给图灵的服务器发送数据包（包含你对他说的话）

图灵的服务器会以一定的规则给你返回数据包（包含他回复你的话）

你需要一个Tuling Key来告诉图灵服务器你有权和他对话，我这里免费提供一些：

8edce3ce905a4c1dbb965e6b35c3834d
eb720a8970964f3f855d863d24406576
1107d5601866433dba9599fac1bc0083
71f28bf79c820df10d39b4074345ef8c

下面我做一个配置图灵机器人的简单介绍，你想要自行了解或者申请Tuling Key可以看这里

发送的规则简而言之是这样的：

{
    'key'    : 'TULING_KEY',
    'info'   : 'YOUR_MSG',
    'userid' : 'USERID',
}

其中userId是用户的标志，让机器人知道你是你。（也就是一个Tuling Key可以有多个用户）

而返回的内容基本是这样的：

{
    'code': 0,
    'text': 'RETURN_MSG',
}

我们需要的内容就在text键里面。

这里我们使用requests包完成整个操作（已经包含在itchat包的安装中了）。

最后值得一提的就是这是一个post请求，那么直接上代码应该比我絮絮叨叨的说要直观很多。

#coding=utf8
import requests

apiUrl = 'http://www.tuling123.com/openapi/api'
data = {
    'key'    : '8edce3ce905a4c1dbb965e6b35c3834d', # 如果这个Tuling Key不能用，那就换一个
    'info'   : 'hello', # 这是我们发出去的消息
    'userid' : 'wechat-robot', # 这里你想改什么都可以
}
# 我们通过如下命令发送一个post请求
r = requests.post(apiUrl, data=data).json()

# 让我们打印一下返回的值，看一下我们拿到了什么
print(r)

我们可以看到他回复了你好。

reply-hello

至此我们已经理解并掌握了所有需要的内容，下面将其组装起来即可。

五、实验程序

我先从概念上说一下组装是一个怎么样的过程。

当然，如果你觉得代码更直观，我也在代码中为你写好了注释。

这里我们首先将与图灵服务器的交互定义为一个函数。

我们需要这个函数接收我们要发送给图灵的消息，返回图灵返回给我们的消息。

再将与图灵交互并返回图灵返回结果的操作写成函数并在itchat中注册。

最后启动itchat，我们的程序就完成了。

#coding=utf8
import requests
import itchat

KEY = '8edce3ce905a4c1dbb965e6b35c3834d'

def get_response(msg):
    # 这里我们就像在“3. 实现最简单的与图灵机器人的交互”中做的一样
    # 构造了要发送给服务器的数据
    apiUrl = 'http://www.tuling123.com/openapi/api'
    data = {
        'key'    : KEY,
        'info'   : msg,
        'userid' : 'wechat-robot',
    }
    try:
        r = requests.post(apiUrl, data=data).json()
        # 字典的get方法在字典没有'text'值的时候会返回None而不会抛出异常
        return r.get('text')
    # 为了防止服务器没有正常响应导致程序异常退出，这里用try-except捕获了异常
    # 如果服务器没能正常交互（返回非json或无法连接），那么就会进入下面的return
    except:
        # 将会返回一个None
        return

# 这里是我们在“1. 实现微信消息的获取”中已经用到过的同样的注册方法
@itchat.msg_register(itchat.content.TEXT)
def tuling_reply(msg):
    # 为了保证在图灵Key出现问题的时候仍旧可以回复，这里设置一个默认回复
    defaultReply = 'I received: ' + msg['Text']
    # 如果图灵Key出现问题，那么reply将会是None
    reply = get_response(msg['Text'])
    # a or b的意思是，如果a有内容，那么返回a，否则返回b
    # 有内容一般就是指非空或者非None，你可以用`if a: print('True')`来测试
    return reply or defaultReply

# 为了让实验过程更加方便（修改程序不用多次扫码），我们使用热启动
itchat.auto_login(hotReload=True)
itchat.run()

六、实验结果

在本机上通过如下命令可以运行该程序

python3 main.py

扫码登陆后程序就成功运行了。

之后在手机上使用别的账号给自己的微信号发送消息即可获得机器人的回复。

这里给出使用的效果图：

demo

如果你想要通过与其他用户的交互完成该操作，自行在注册的函数中进行修改即可。

如果你想要进一步了解使用Python控制微信的细节，你也可以去到项目主页itchat。

或者直接阅读文档也是不错的选择。

如果你的本地环境并非Python3也没有关系，itchat同样完美支持Python2。

七、代码获取

我将整个项目目录做了一个打包，你可以直接下载后运行。

你可以在这里下载。

如果有什么问题，欢迎在我的主页留言或者邮件联系我。

posted on 2022-06-02 16:24  Carl_99  阅读(703)  评论(2)  编辑  收藏  举报
Copyright © 2024 Carl_99
Powered by .NET 9.0 on Kubernetes Powered By: 博客园