{"id":28472900,"url":"https://github.com/fromsko/wechat-hook","last_synced_at":"2025-10-04T02:44:05.642Z","repository":{"id":214341773,"uuid":"736283993","full_name":"Fromsko/Wechat-Hook","owner":"Fromsko","description":"基于 WeChat-PyRobot 简单封装的一个机器人骨架","archived":false,"fork":false,"pushed_at":"2023-12-27T13:46:50.000Z","size":679,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-10T23:15:04.382Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Fromsko.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-12-27T13:37:03.000Z","updated_at":"2025-02-18T12:42:17.000Z","dependencies_parsed_at":"2023-12-27T14:52:28.978Z","dependency_job_id":null,"html_url":"https://github.com/Fromsko/Wechat-Hook","commit_stats":null,"previous_names":["fromsko/wechat-hook"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/Fromsko/Wechat-Hook","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fromsko%2FWechat-Hook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fromsko%2FWechat-Hook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fromsko%2FWechat-Hook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fromsko%2FWechat-Hook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Fromsko","download_url":"https://codeload.github.com/Fromsko/Wechat-Hook/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fromsko%2FWechat-Hook/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278256775,"owners_count":25957086,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-04T02:00:05.491Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-07T11:30:44.229Z","updated_at":"2025-10-04T02:44:05.599Z","avatar_url":"https://github.com/Fromsko.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Wechat-Hook\n\n\u003e 基于 [WeChat-PyRobot](https://github.com/kanadeblisst00/WeChat-PyRobot) 简单封装的一个机器人骨架\n\n## 📑 已实现\n\n- [x] Hook 消息 `on_message | on_command`\n- [x] 回调函数 `decorator`\n- [ ] 防撤回并记录 `msg_id`\n- [ ] 可选重载 or 直接启动\n\n## 🔗 数据定义\n\n### 消息体 `Event`\n\n+ 定义\n    ```python\n    class Message(BaseModel):\n        \"\"\"\n        消息模型。\n    \n        属性:\n        - `localid`: 本地ID\n        - `msgid`: 消息ID\n        - `msg_type`: 消息类型\n        - `is_self_msg`: 是否自己发送的消息\n        - `timestamp`: 时间戳\n        - `sender`: 发送者\n        - `content`: 消息内容\n        - `room_sender`: 房间发送者\n        - `sign`: 签名\n        - `thumb_path`: 缩略图路径，可以是字符串或者 None\n        - `file_path`: 文件路径，可以是字符串或者 None\n        \"\"\"\n        localid: Optional[int]\n        msgid: Optional[int]\n        msg_type: Optional[int]\n        is_self_msg: Optional[int]\n        timestamp: Optional[int]\n        sender: Optional[str]\n        content: Optional[str]\n        room_sender: Optional[str]\n        sign: Optional[str]\n        thumb_path: Optional[Union[str, None]]\n        file_path: Optional[Union[str, None]]\n    \n    \n    class Event(BaseModel):\n        Msg: Message\n        MsgType: MessageType\n        CMD: Optional[Tuple[str, Dict]]\n    ```\n\n### 消息类型 `MessageType`\n\n+ 定义\n    ```python\n    class MessageType(Enum):\n        \"\"\"\n        消息类型枚举。\n    \n        枚举值:\n        - `TEXT`: 文本消息\n        - `IMAGE`: 图片消息\n        - `XML`: XML卡片消息\n        - `NOTIFY`: 事件通知消息\n        - `LOCAL`: 位置信息\n        - `CUSTOM_TYPE`: 自定义消息\n        \"\"\"\n        TEXT = 1\n        IMAGE = 3\n        XML = 49\n        NOTIFY = 1000\n        LOCAL = 48\n        CUSTOM_TYPE = 200  # 自定义的消息类型\n    ```\n\n### 消息事件 `on_message`\n\n\u003cdetails\u003e\n\u003csummary\u003e函数原型\u003c/summary\u003e\n\n```python\ndef handle_message(self, msg_type: MessageType) -\u003e Callable:\n    \"\"\"\n    消息处理装饰器。\n\n    参数:\n    - `msg_type`: 消息类型\n\n    返回:\n    - `Callable`: 装饰器函数\n    \"\"\"\n```\n\n\u003c/details\u003e\n\n---\n\n**使用案例**\n\n1. 文本消息\n   ```python\n   @on_message(MessageType.TEXT)\n   def handle_public_message(event: Event) -\u003e None:\n       \"\"\"处理文本消息逻辑\"\"\"\n       log.info(\n           \"文本消息: {sender}\",\n           sender=event.Msg.sender,\n       )\n   ```\n\n2. 图片消息\n    ```python\n    @on_message(MessageType.IMAGE)\n    def handle_image_message(event: Event) -\u003e None:\n        \"\"\"处理图片消息逻辑\"\"\"\n        log.info(\n            \"图片消息: {sender}\",\n            sender=event.Msg.sender,\n        )\n    ```\n\n### 命令事件 `on_command`\n\n\u003cdetails\u003e\n\u003csummary\u003e函数原型\u003c/summary\u003e\n\n```python\ndef handle_command(self, command_name: str, priority: int = 0) -\u003e Callable:\n    \"\"\"\n    命令处理装饰器。\n\n    参数:\n    - `command_name`: 命令名称\n    - `priority`: 命令优先级\n\n    返回:\n    - `Callable`: 装饰器函数\n    \"\"\"\n```\n\n\u003c/details\u003e\n\n---\n\n**三种固定格式**\n\n1. 触发条件: `#聊天 xxx`\n    ```python\n    @on_command('聊天', priority=1)\n    def handle_chat_command(event: Event) -\u003e None:\n        \"\"\"处理 聊天 命令逻辑\"\"\"\n    ```\n\n2. 触发条件: 当 `Bot` 被用户 @\n\n   ```python\n   @on_command('at', priority=2)\n   def handle_at_command(event: Event) -\u003e None:\n       \"\"\"处理被用户 at 命令逻辑\"\"\"\n   ```\n\n3. 触发条件: `Bot`自身响应\n   ```python\n   @on_command('bot', priority=2)\n   def handle_bot_command(event: Event) -\u003e None:\n       \"\"\"处理机器人自身的信息\"\"\"\n   ```\n\n**自定义**\n\u003e 修改: `libs.bot.event: command_parser`\n\u003cdetails\u003e\n\u003csummary\u003e函数原型\u003c/summary\u003e\n\n```python\ndef command_parser(event: Event) -\u003e None:\n    \"\"\"\n    命令解析\n\n    参数:\n        - `event`: 消息体\n    \"\"\"\n    try:\n        if event.Msg.content.startswith(\"#\"):\n            command = event.Msg.content[:3].split(\"#\")[1]\n            arg = event.Msg.content[3:]\n            event.CMD = (\"#\", {command: arg})\n            MsgHandler.process_command(command, event=event)\n        elif event.Msg.content.startswith(\"@\"):\n            event_msg = event.Msg.content.split(\"\\u2005\")\n            command = event_msg[0]  # 调用者\n            arg = event_msg[1]  # 内容\n            event.CMD = (\"at\", {command: arg})\n            MsgHandler.process_command(\"at\", event=event)\n        elif event.Msg.is_self_msg:\n            MsgHandler.process_command(\"bot\", event=event)\n        else:\n            MsgHandler.process_message(event.MsgType, event=event)\n\n    except (IndexError, ParameterError) as err:\n        log.error(f\"command_parser err: {err}\")\n```\n\n\u003c/details\u003e\n\n\n## 🙏 鸣谢\n\n感谢以下开源项目，它们为本项目的开发提供了重要支持：\n\n- [Pillow](https://pillow.readthedocs.io/en/stable/): 🖼️ 用于图像处理的 Python 库。\n- [WeChat-PyRobot](https://github.com/kanadeblisst00/WeChat-PyRobot) 💉 注入Python到微信实现微信机器人 \n\n## ©️ 许可\n\n本项目基于 MIT 许可证，请查阅 LICENSE 文件以获取更多信息。","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffromsko%2Fwechat-hook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffromsko%2Fwechat-hook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffromsko%2Fwechat-hook/lists"}