Python SDK
python sdk 的接口文档
在项目中引用
使用 pip
pip install wx-connector-pysdk或使用 uv
uv pip install wx-connector-pysdk简单的代码示例可以查看 Python SDK 的 README 页面
方法文档
set_url
设置 WxConnectorProvider 提供 api 的 url 格式一般为 localhost:<port> —— localhost:8022
参数
参数意义
base_url: str
WxConnectorProvider 提供 api 的 url
start_event_listen
启动本包的事件监听器，用于加载event对象
strat_wx
用于启动 WeChat
参数
参数意义
wx_path: str
WeChat 主程序的完整路径
start_listeners
用于打开监听窗口并启动 WxConnectorProvider 端的事件监听
参数
参数意义
listeners: List[str]
监听对象（用户备注名和群名备注名）
send_text
用于向指定窗口发送普通文本消息（支持排版和wx表情）
参数
参数意义
msg: str
需要发送的消息文本内容
send_to: str
用于发送的窗口（同listeners） 也就是监听对象的备注名，开始监听时传的什么就用什么
send_file
用于向指定窗口发送本地文件消息
参数
参数意义
file_path: str
需要发送的本地文件的完整路径
send_to: str
用于发送的窗口（同listeners） 也就是监听对象的备注名，开始监听时传的什么就用什么
event
是一个 EventManager 对象，全局单例，用于处理 WxConnectorProvider 的 Websocket 传递的事件
on
一个含参数装饰器，用于定义 Event 处理函数
支持的 Event 事件类型请查看 WxConnectorProvider 的 api 文档的事件监听部分
使用示例
@event.on("NewMessageWithoutSelfEvent")
def handle_new_msg(msg: WMessage) -> None:
print(f"从{msg.MsgFromWindow}窗口收到{msg.MsgSenderName}的信息说：{msg.MsgContent}")at_by_username_in_group
用于在群内使用用户备注名at对方
参数
参数意义
username: str
需要 at 的用户的备注名
window_title: str
群独立聊天窗口
Last updated