概述 ntwork 开源框架

ItChat 是一个基于 Python 的微信个人号接口库。它通过封装微信 API，使得开发者可以使用 Python 来方便地与微信进行交互，实现一系列微信相关的功能。这些功能包括但不限于发送和接收消息、获取好友列表和详细信息、以及进行群聊操作等。ItChat 提供了一套简洁而强大的 API，让开发者能够轻松地在 Python 中执行微信相关的操作。

ItChat 支持 Python 2.x 和 3.x 版本，并且可以在多个操作系统平台上运行，包括 Windows、Mac 和 Linux 等。这使得开发者可以根据自己的需求和环境选择适合的 Python 版本和操作系统。

ItCha t的入门使用相对简单。首先，你需要通过 pip 命令安装 ItChat 库。安装完成后，你可以通过引入 ItChat 模块，并调用其提供的函数来实现所需的功能。例如，你可以使用 ItChat 的 login() 函数来扫码登录微信，然后使用 get_friends() 函数来获取好友列表和详细信息。此外 ItChat 还提供了发送消息、注册消息回复等功能，使开发者能够根据自己的需求定制微信机器人的行为。

ItChat 不仅是一个功能强大的工具，也是一个开源项目，这意味着开发者可以根据自己的需求对其进行扩展和定制。通过 ItChat，你可以开发出各种有趣的微信应用，如自动回复消息、数据采集、搭建微信聊天机器人等。

框架 API 文档：https://itchat.readthedocs.io/zh/latest/api/

下载安装 itchat 库

使用 pip 进行安装下载 itchat 库

<code>pip install itchat

清华大学开源软件镜像站

使用如下命令配置 pip 使用清华大学的镜像源：

pip install itchat -i https://pypi.tuna.tsinghua.edu.cn/simple

如果永久设置这个镜像源，可以创建一个 pip 配置文件（例如：~/.pip/pip.conf）并添加如下内容：

[global]

index-url = https://pypi.tuna.tsinghua.edu.cn/simple

itchat 登录异常解决方案

import itchat

itchat.auto_login()

运行测试结果

Getting uuid of QR code.

Downloading QR code.

Please scan the QR code to log in.

Please press confirm on your phone.

Traceback (most recent call last):

······

xml.parsers.expat.ExpatError: mismatched tag: line 64, column 4

异常解决方案：更新 itchat 库

itchat 库 zip 压缩包链接 https://download.csdn.net/download/qq_47452807/89129949?spm=1001.2014.3001.5503

点击 立即下载 下载新的 itchat 库 zip 压缩包

解压缩 > itchat 文件夹

进行 site-packages 替换 itchat 原库文件夹

重新运行测试

<code>Ready to login.

Getting uuid of QR code.

Downloading QR code.

Please press confirm on your phone.

Loading the contact, this may take a little while.

Login successfully as 一语中的

Start auto replying.

itchat 协议说明

特别注意：使用itchat或其他类似工具进行微信操作需要遵守微信的使用协议和相关法律法规，不得用于非法或恶意目的。同时，由于微信的协议和接口可能随时变化，使用 itchat 等第三方工具时需要注意及时更新和适配。

现在注册的微信已经禁止网页版登陆了，itchat 是基于 web 协议，如果你的微信是 2017 年之后的，或者未进行实名认证的微信号，可能会遇到登录失败的报错。请选择合理的微信号进行登录。

给文件传输助手发信息

import itchat

itchat.auto_login()

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

运行结果：

自动回复文本消息

<code>import itchat

from itchat.content import *

@itchat.msg_register(TEXT)

def text_reply(msg):

return msg.text

itchat.auto_login()

itchat.run()

函数说明：

开启一个消息注册器监听来自用户私信的文本类型消息，自动回复用户私信发送消息的内容（文本消息）

测试结果

自动回复群消息

开启一个消息注册器监听来自群的文本类型消息。当收到一个来自微信群的文本消息时，请调用定义的处理函数，实现自动回复。

<code>import itchat

from itchat.content import *

@itchat.msg_register(TEXT, isGroupChat=True)

def text_reply(msg):

if msg.isAt:

msg.user.send(u'@%s I received: %s' % (msg.actualNickName, msg.text))

itchat.auto_login()

itchat.run()

itchat.msg_register 这是 itchat 库中的一个函数，用于注册消息处理函数。当你收到微信消息时，itchat会根据你的注册情况调用相应的处理函数。

TEXT 这是一个常量，代表文本消息类型。当itchat收到一个文本消息时，它会检查是否有为这个类型注册的处理函数。

isGroupChat=True 这是一个参数，用于指定这个函数只处理来自微信群的文本消息，而不是来自好友或公众号等其他来源的消息。

运行结果：

itchat 消息类型

消息注册器消息类型：itchat.content

<code>TEXT = 'Text'

MAP = 'Map'

CARD = 'Card'

NOTE = 'Note'

SHARING = 'Sharing'

PICTURE = 'Picture'

RECORDING = VOICE = 'Recording'

ATTACHMENT = 'Attachment'

VIDEO = 'Video'

FRIENDS = 'Friends'

SYSTEM = 'System'

获取 uuid 账号标识

如何要进行登录你需要先得到一个 uuid，当下载 QRcode 需要传递 uuid 生成二维码，为了检查登录状态，还需要 uuid 判断当前用户。

import itchat

uuid = itchat.get_QRuuid()

控制台登录二维码显示

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

itchat.auto_login(enableCmdQR=True)

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

itchat.auto_login(enableCmdQR=2)

注意：部分 linux 系统，块字符的宽度为一个字符（正常应为两字符）故赋值为 2

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

itchat.auto_login(enableCmdQR=-1)

二维码图片显示

itchat 库提供了 get_QR 函数用于下载显示二维码。

def get_QR(self, uuid=None, enableCmdQR=False, picDir=None, qrCallback=None):

''' download and show qrcode

获取登录二维码并且显示

import itchat

uuid = itchat.get_QRuuid()

itchat.get_QR(uuid)

注意：执行 itchat.auto_login() 自动登录功能生成二维码进行预览显示。

检测登录状态

输出当前微信登陆状态的状态码

import itchat

uuid = itchat.get_QRuuid()

status_code = itchat.check_login(uuid)

print(status_code)

如果未设置 uuid 则将使用您获取的最新 uuid：

import itchat

status_code = itchat.check_login()

print(status_code)

状态码说明

- 200: 登陆成功

- 201: 等待客户端确认登陆

- 408: uuid 超时

- 0 : 异常报错

主动退出登陆

import itchat

itchat.auto_login()

time.sleep(10)

item

退出程序暂存登陆状态

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

import itchat

itchat.auto_login(hotReload=True)

保存登陆数据 itchat.pkl

pickle 数据格式说明

pkl 是 Python 编程语言中的一种数据序列化文件格式，其全称是 pickle。这种格式可以将 Python 中的任意对象转换为一种可以保存到磁盘上或通过网络传输的格式，然后再将这些对象从磁盘上读取出来或者从网络上接收过来，重新还原为原来的 Python 对象。这种能力使得 pkl 格式文件在 Python 编程中非常有用，尤其是在需要保存和加载复杂数据结构或自定义对象时。

具体来说 pkl 文件是以二进制格式保存的，它包含了对象的状态信息，包括对象的数据和方法。这种存储方式可以将Python项目过程中用到的一些暂时变量、或者需要提取、暂存的字符串、列表、字典等数据保存起来，然后在需要使用的时候再进行加载。

在 Python 中 pickle 模块提供了 dump() 和 load() 函数，用于将 Python 对象保存到 pkl 文件和从 pkl 文件加载对象到内存中。使用这些函数，可以方便地实现 Python 对象的序列化和反序列化，从而实现数据的持久化存储和传输。

需要注意的是，由于pkl文件是以二进制格式保存的，因此在不同的操作系统或Python版本之间可能会出现兼容性问题。此外，在处理来自不可信来源的pkl文件时也需要格外小心，因为加载恶意构造的pkl文件可能会导致安全问题。

存储登陆数据

import itchat

itchat.auto_login(hotReload=True)

itchat.dump_login_status("itchat.pkl")

加载登陆数据

import itchat

itchat.load_login_status("itchat.pkl")

注意：itchat.pkl 存储了例如联系人数据、群组数据、个人信息数据······

获取联系人数据

获取当前登陆微信下全部联系人数据（本地数据 / 实时数据）

get_friends 函数

def get_friends(self, update=False):

特别注意：如果不设置 update 获取是本地 local 数据（itchat.pkl 数据）

读取实时数据：读取当前登陆态数据

import itchat

itchat.auto_login(hotReload=True)

friendList = itchat.get_friends(update=True)

for friend in friendList:

print(friend)

读取本地数据：不登录也同样可以读取数据（itchat.pkl 数据加载）

import itchat

itchat.load_login_status("itchat.pkl")

friendList = itchat.get_friends(update=False)

for friend in friendList:

print(friend)

我们没有进行 itchat 扫描登陆操作，通过加载 itchat.pkl 登陆数据，同样查询到联系人数据。

查询联系人用户数据

使用 search_friends 方法可以搜索用户

1. 仅获取自己的用户信息。

2. 获取特定 UserName 的用户信息。

3. 获取备注、微信号、昵称中的任何一项等于 name 键值的用户。

4. 获取备注、微信号、昵称分别等于相应键值的用户。

5. ······

函数体说明

def search_friends(self, name=None, userName=None, remarkName=None, nickName=None, wechatAccount=None):

案例说明

获取自己的用户信息，返回自己的属性字典

itchat.search_friends()

获取特定 UserName 的用户信息

itchat.search_friends(userName='@abcdefg1234567')code>

获取任何一项等于 name 键值的用户

itchat.search_friends(name='littlecodersh')code>

获取分别对应相应键值的用户

itchat.search_friends(wechatAccount='littlecodersh')code>

组合查询

itchat.search_friends(name='LittleCoder机器人', wechatAccount='littlecodersh')code>

wechatAccount 安全性特别说明

由于腾讯考虑安全性问题，更新了 web 端安全信息保护机制。目前来说，微信网页端已经无法获取用户微信账号 wechatAccount 属性。所以 itchat.search_friends(wechatAccount=‘littlecodersh’) 查询都是为 [] 空。

用户属性案例说明