其他类(方法)

WxResponse

该类用于该项目多个方法的返回值

# 这里假设result为某个方法的WxResponse类型返回值
result: WxResponse = ...

# 判断是否成功
if result:
    data = result['data'] # 成功,获取返回数据,大多数情况下为None
else:
    print(result['message'])  # 该方法调用失败,打印错误信息

WxParam

该类用于该项目的一些参数,在获取WeChat实例前,可以通过修改该类的属性来修改默认参数

属性类型默认值描述
ENABLE_FILE_LOGGERboolTrue是否启用日志文件
DEFAULT_SAVE_PATHstr./wxautox下载文件/图片默认保存路径
✨MESSAGE_HASHboolFalse是否启用消息哈希值用于辅助判断消息,开启后会稍微影响性能
DEFAULT_MESSAGE_XBIASint51头像到消息X偏移量,用于消息定位,点击消息等操作
FORCE_MESSAGE_XBIASboolTrue是否强制重新自动获取X偏移量,如果设置为True,则每次启动都会重新获取,系统设置了分辨率缩放时开启
LISTEN_INTERVALint1监听消息时间间隔,单位秒
✨LISTENER_EXCUTOR_WORKERSint4监听执行器线程池大小,根据自身需求和设备性能设置
SEARCH_CHAT_TIMEOUTint5搜索聊天对象超时时间,单位秒
✨NOTE_LOAD_TIMEOUTint30微信笔记加载超时时间,单位秒

示例:

from wxautox import WxParam

# 设置8个监听线程
WxParam.LISTENER_EXCUTOR_WORKERS = 8
...

NewFriendElement

NewFriendElement

属性类型描述(以上图为例)
namestr对方名(诸葛孔明)
msgstr申请信息(wxautox)
acceptablebool是否可接受(True)

accept

同意添加好友

参数:

参数名类型默认值说明
remarkstrNone备注
tagslistNone标签
permissionstr'朋友圈'朋友圈权限,可选值:'全部'、'仅聊天'

✨delete

删除好友申请

参数:无

✨reply

回复好友申请

参数:

参数名类型默认值说明
textstr必填回复信息

✨get_account

获取申请添加的好友的账号信息

{{< callout type="info" >}} 该方法仅接受好友申请后,已经成为好友,才能获取到对方账号信息 {{< /callout >}}

参数:

参数名类型默认值说明
waitint5等待时间

返回值:str

✨LoginWnd

{{< cards >}} {{< card link="/docs/example/#6-自动登录" title="👉查看自动登录、二维码示例" tag="点击跳转" tagType="info" >}} {{< /cards >}}

该类用于微信登录、获取二维码等操作

from wxautox import LoginWnd

wxlogin = LoginWnd(app_path="...")

LoginWnd

参数:

参数名类型默认值说明
app_pathstrNone微信客户端路径

属性:无

login

登录微信

参数:

参数名类型默认值说明
timeoutint10登录超时时间

返回值:WxResponse

get_qrcode

获取二维码

参数:

参数名类型默认值说明
pathstrNone二维码图片的保存路径,None即本地目录下的wxauto_qrcode文件夹

返回值:str,二维码图片的路径

reopen

重新打开微信,为了避免各种弹窗影响操作,建议调用该方法后再执行login或get_qrcode

参数:无

返回值:无

open

启动微信,建议在初始化的时候传入app_path参数,否则可能会启动失败

参数:无

返回值:无

WeChatImage

from wxautox.ui.component import WeChatImage

imgwnd = WeChatImage()

微信图片/视频窗口类,用于处理微信图片或图片窗口的各种操作

wxauto_image_wnd

ocr

识别图片中的文字,仅支持图片,不支持视频

参数:

参数名类型默认值说明
waitint10隐性等待时间

返回值:str,识别到的文字

save

保存图片/视频

参数:

参数名类型默认值说明
dir_pathstrNone保存的目录路径,None即本地路径下自动生成
timeoutint10保存超时时间

返回值:Path,保存的文件路径

close

关闭图片/视频窗口

参数:无

返回值:无

✨WeChatDialog

微信对话框对象,用于处理微信对话框的各种操作

wxauto_dialog_wnd

click_button

选择对话框中的选项,如“确定”、“取消”等

参数:无

返回值:WxResponse对象

get_all_text

获取对话框中所有的文字内容

参数:无

返回值:str

close

关闭对话框

参数:无

返回值:无

✨get_wx_clients

获取所有已登录的微信3.9客户端

from wxautox import get_wx_clients

# 获取所有微信客户端
clients = get_wx_clients()
for client in clients:
    print(f"微信客户端: {client}")

返回值:List[WeChat]

WARNING

wxauto项目不支持一切违反官方用户协议的操作,不建议不支持不提供微信多开的方法或行为。 但是如果你自行使用其他方法多开微信,wxauto不承担由你自行多开的行为导致的风险,也不保证所有功能的正常调用。

✨get_wx_logins

from wxautox import get_wx_logins

# 获取所有微信客户端
login_windows = get_wx_logins()

# 关闭所有登录窗口
for login_window in login_windows:
    login_window.close()  # 关闭

返回值:List[LoginWnd]

WARNING

wxauto项目不支持一切违反官方用户协议的操作,不建议不支持不提供微信多开的方法或行为。 但是如果你自行使用其他方法多开微信,wxauto不承担由你自行多开的行为导致的风险,也不保证所有功能的正常调用。