yunhu2onebot12

Name	yunhu2onebot12 JSON
Version	1.1.1 JSON
	download
home_page	None
Summary	云湖事件到OneBot12的协议格式转换器
upload_time	2025-07-15 07:51:22
maintainer	None
docs_url	None
author	None
requires_python	>=3.7
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 云湖平台事件转换模块 (YunhuAdapter4OneBot12)

## 功能概述
本模块用于将云湖(即时通讯平台)的事件数据转换为标准的OneBot12格式。支持消息、通知等多种事件类型

## 安装方法
```bash
pip install yunhu2onebot12
```

## 使用方法
### 基本使用
```python
from yunhu2onebot12 import Converter

# 创建转换器实例
converter = Converter()

# 云湖平台原始事件数据
yunhu_event = {
    "version": "1.0",
    "header": {
        "eventId": "c192ccc83d5147f2859ca77bcfafc9f9",
        "eventType": "message.receive.normal",
        "eventTime": 1748613099002
    },
    "event": {
        # ... 事件数据 ...
    }
}

# 转换为OneBot12格式
onebot_event = converter.convert(yunhu_event)
```

## 支持的事件类型
| 云湖事件类型 | 
|-------------| 
| message.receive.normal | 
| message.receive.instruction | 
| bot.followed | 
| bot.unfollowed | 
| group.join | 
| group.leave | 
| button.report.inline | 
| bot.shortcut.menu | 

## 消息类型支持
支持以下内容类型的消息转换：
- 文本(text)
- 图片(image)
- 视频(video)
- 文件(file)
- 表单指令(form)

## 特殊字段处理
部分云湖特有字段会在转换后的OneBot事件中以`yunhu_`前缀的非标准字段形式保留：
- `yunhu_form`: 表单类型指令数据
- `yunhu_button`: 按钮相关数据
- `yunhu_menu`: 快捷菜单数据

## 错误处理
- 如果传入不支持的事件类型，方法会返回`None`
- 当事件数据格式错误时会抛出`ValueError`

## 注意事项
1. 使用 Python 3.7 及更高版本
2. 本模块仅处理事件格式转换，不包含网络通信功能
3. 云湖特有字段在OneBot12标准中可能不被其他组件识别
4. 表单消息/按钮/快捷菜单 事件是云湖平台特有功能，转换后会添加`yunhu_`前缀

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "yunhu2onebot12",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "wsu2059q <wsu2059@qq.com>",
    "download_url": "https://files.pythonhosted.org/packages/81/bd/09cb134006abf07b87fc48aa697647010f853becaebaac29096d958c9bd7/yunhu2onebot12-1.1.1.tar.gz",
    "platform": null,
    "description": "# \u4e91\u6e56\u5e73\u53f0\u4e8b\u4ef6\u8f6c\u6362\u6a21\u5757 (YunhuAdapter4OneBot12)\n\n## \u529f\u80fd\u6982\u8ff0\n\u672c\u6a21\u5757\u7528\u4e8e\u5c06\u4e91\u6e56(\u5373\u65f6\u901a\u8baf\u5e73\u53f0)\u7684\u4e8b\u4ef6\u6570\u636e\u8f6c\u6362\u4e3a\u6807\u51c6\u7684OneBot12\u683c\u5f0f\u3002\u652f\u6301\u6d88\u606f\u3001\u901a\u77e5\u7b49\u591a\u79cd\u4e8b\u4ef6\u7c7b\u578b\n\n## \u5b89\u88c5\u65b9\u6cd5\n```bash\npip install yunhu2onebot12\n```\n\n## \u4f7f\u7528\u65b9\u6cd5\n### \u57fa\u672c\u4f7f\u7528\n```python\nfrom yunhu2onebot12 import Converter\n\n# \u521b\u5efa\u8f6c\u6362\u5668\u5b9e\u4f8b\nconverter = Converter()\n\n# \u4e91\u6e56\u5e73\u53f0\u539f\u59cb\u4e8b\u4ef6\u6570\u636e\nyunhu_event = {\n    \"version\": \"1.0\",\n    \"header\": {\n        \"eventId\": \"c192ccc83d5147f2859ca77bcfafc9f9\",\n        \"eventType\": \"message.receive.normal\",\n        \"eventTime\": 1748613099002\n    },\n    \"event\": {\n        # ... \u4e8b\u4ef6\u6570\u636e ...\n    }\n}\n\n# \u8f6c\u6362\u4e3aOneBot12\u683c\u5f0f\nonebot_event = converter.convert(yunhu_event)\n```\n\n## \u652f\u6301\u7684\u4e8b\u4ef6\u7c7b\u578b\n| \u4e91\u6e56\u4e8b\u4ef6\u7c7b\u578b | \n|-------------| \n| message.receive.normal | \n| message.receive.instruction | \n| bot.followed | \n| bot.unfollowed | \n| group.join | \n| group.leave | \n| button.report.inline | \n| bot.shortcut.menu | \n\n## \u6d88\u606f\u7c7b\u578b\u652f\u6301\n\u652f\u6301\u4ee5\u4e0b\u5185\u5bb9\u7c7b\u578b\u7684\u6d88\u606f\u8f6c\u6362\uff1a\n- \u6587\u672c(text)\n- \u56fe\u7247(image)\n- \u89c6\u9891(video)\n- \u6587\u4ef6(file)\n- \u8868\u5355\u6307\u4ee4(form)\n\n## \u7279\u6b8a\u5b57\u6bb5\u5904\u7406\n\u90e8\u5206\u4e91\u6e56\u7279\u6709\u5b57\u6bb5\u4f1a\u5728\u8f6c\u6362\u540e\u7684OneBot\u4e8b\u4ef6\u4e2d\u4ee5`yunhu_`\u524d\u7f00\u7684\u975e\u6807\u51c6\u5b57\u6bb5\u5f62\u5f0f\u4fdd\u7559\uff1a\n- `yunhu_form`: \u8868\u5355\u7c7b\u578b\u6307\u4ee4\u6570\u636e\n- `yunhu_button`: \u6309\u94ae\u76f8\u5173\u6570\u636e\n- `yunhu_menu`: \u5feb\u6377\u83dc\u5355\u6570\u636e\n\n## \u9519\u8bef\u5904\u7406\n- \u5982\u679c\u4f20\u5165\u4e0d\u652f\u6301\u7684\u4e8b\u4ef6\u7c7b\u578b\uff0c\u65b9\u6cd5\u4f1a\u8fd4\u56de`None`\n- \u5f53\u4e8b\u4ef6\u6570\u636e\u683c\u5f0f\u9519\u8bef\u65f6\u4f1a\u629b\u51fa`ValueError`\n\n## \u6ce8\u610f\u4e8b\u9879\n1. \u4f7f\u7528 Python 3.7 \u53ca\u66f4\u9ad8\u7248\u672c\n2. \u672c\u6a21\u5757\u4ec5\u5904\u7406\u4e8b\u4ef6\u683c\u5f0f\u8f6c\u6362\uff0c\u4e0d\u5305\u542b\u7f51\u7edc\u901a\u4fe1\u529f\u80fd\n3. \u4e91\u6e56\u7279\u6709\u5b57\u6bb5\u5728OneBot12\u6807\u51c6\u4e2d\u53ef\u80fd\u4e0d\u88ab\u5176\u4ed6\u7ec4\u4ef6\u8bc6\u522b\n4. \u8868\u5355\u6d88\u606f/\u6309\u94ae/\u5feb\u6377\u83dc\u5355 \u4e8b\u4ef6\u662f\u4e91\u6e56\u5e73\u53f0\u7279\u6709\u529f\u80fd\uff0c\u8f6c\u6362\u540e\u4f1a\u6dfb\u52a0`yunhu_`\u524d\u7f00\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "\u4e91\u6e56\u4e8b\u4ef6\u5230OneBot12\u7684\u534f\u8bae\u683c\u5f0f\u8f6c\u6362\u5668",
    "version": "1.1.1",
    "project_urls": {
        "Homepage": "https://github.com/wsu2059q/YunhuAdapter4OneBot12",
        "Issues": "https://github.com/wsu2059q/YunhuAdapter4OneBot12/issues",
        "Repository": "https://github.com/wsu2059q/YunhuAdapter4OneBot12"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "64f5a1865f446245ea8ceb00c65aa4c2e8b9327eb576cb0b1266de7127c2142b",
                "md5": "5f3a4b5453e6cc1efda40fb7c6569fe4",
                "sha256": "c005d77c6f3cb02cc2433fbf69af7557cac62ac633fc8a6bd6ff006833358a0e"
            },
            "downloads": -1,
            "filename": "yunhu2onebot12-1.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5f3a4b5453e6cc1efda40fb7c6569fe4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 5803,
            "upload_time": "2025-07-15T07:51:21",
            "upload_time_iso_8601": "2025-07-15T07:51:21.484959Z",
            "url": "https://files.pythonhosted.org/packages/64/f5/a1865f446245ea8ceb00c65aa4c2e8b9327eb576cb0b1266de7127c2142b/yunhu2onebot12-1.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "81bd09cb134006abf07b87fc48aa697647010f853becaebaac29096d958c9bd7",
                "md5": "1ae5a0210c3febfa679931f8ea8f4fcd",
                "sha256": "4f504861b9268abd92c4e9c05e2f6cecc4f63b4fd4e8f032c735ae3e70e9aa25"
            },
            "downloads": -1,
            "filename": "yunhu2onebot12-1.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "1ae5a0210c3febfa679931f8ea8f4fcd",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 5451,
            "upload_time": "2025-07-15T07:51:22",
            "upload_time_iso_8601": "2025-07-15T07:51:22.721905Z",
            "url": "https://files.pythonhosted.org/packages/81/bd/09cb134006abf07b87fc48aa697647010f853becaebaac29096d958c9bd7/yunhu2onebot12-1.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-15 07:51:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "wsu2059q",
    "github_project": "YunhuAdapter4OneBot12",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "yunhu2onebot12"
}