python-library-onebot-protocol 0.1.0__tar.gz

python_library_onebot_protocol-0.1.0/.gitignore

@@ -0,0 +1,21 @@
+__pycache__/
+*.pyc
+*.pyo
+*.egg-info/
+dist/
+build/
+.venv/
+.env
+.env.*
+!.env.example
+# packages 示例本地密钥（*.example 为模板，可提交）
+packages/**/examples/**/.env
+!packages/**/examples/**/.env.example
+packages/**/examples/**/mcp.json
+!packages/**/examples/**/mcp.json.example
+packages/**/examples/**/.sandbox/
+.pytest_cache/
+config.yaml
+logs/
+.cursor/
+uv.lock

python_library_onebot_protocol-0.1.0/PKG-INFO

@@ -0,0 +1,43 @@
+Metadata-Version: 2.4
+Name: python-library-onebot-protocol
+Version: 0.1.0
+Summary: OneBot 风格消息载荷与消息段模型
+Requires-Python: >=3.10
+Requires-Dist: pydantic<3,>=2.0
+Description-Content-Type: text/markdown
+
+# onebot-protocol
+
+OneBot 通信协议，定义消息收发的公共数据结构。基于`OneBot 11`标准，使用 Pydantic 提供类型安全的模型定义。
+
+## 特性
+
+- 完整的消息段（Message Segment）类型：文本、提及、图片、语音、视频、文件、位置、回复等
+- 图片、语音、音频、视频、文件段共用 `FileData`（`name`、`content`、`mime_type`、`size`）
+- 支持 discriminated union，根据 `type` 字段自动解析消息类型
+
+## 文件载荷 `FileData`
+
+| 字段 | 说明 |
+|------|------|
+| `name` | 显示用文件名（可选） |
+| `content` | 内容引用，如 URL、平台资源标识或 Base64 等（可选，编码由实现方约定） |
+| `mime_type` | MIME 类型（可选） |
+| `size` | 字节大小（可选） |
+
+`image` / `voice` / `audio` / `video` / `file` 各段类型的 `data` 均为对应子类，字段与 `FileData` 相同。
+
+## 支持的消息类型
+
+| 类型 | 说明 |
+|------|------|
+| `text` | 纯文本 |
+| `mention` | @某人 |
+| `mention_all` | @所有人 |
+| `image` | 图片 |
+| `voice` | 语音 |
+| `audio` | 音频 |
+| `video` | 视频 |
+| `file` | 文件 |
+| `location` | 位置 |
+| `reply` | 回复 |

python_library_onebot_protocol-0.1.0/README.md

@@ -0,0 +1,35 @@
+# onebot-protocol
+
+OneBot 通信协议，定义消息收发的公共数据结构。基于`OneBot 11`标准，使用 Pydantic 提供类型安全的模型定义。
+
+## 特性
+
+- 完整的消息段（Message Segment）类型：文本、提及、图片、语音、视频、文件、位置、回复等
+- 图片、语音、音频、视频、文件段共用 `FileData`（`name`、`content`、`mime_type`、`size`）
+- 支持 discriminated union，根据 `type` 字段自动解析消息类型
+
+## 文件载荷 `FileData`
+
+| 字段 | 说明 |
+|------|------|
+| `name` | 显示用文件名（可选） |
+| `content` | 内容引用，如 URL、平台资源标识或 Base64 等（可选，编码由实现方约定） |
+| `mime_type` | MIME 类型（可选） |
+| `size` | 字节大小（可选） |
+
+`image` / `voice` / `audio` / `video` / `file` 各段类型的 `data` 均为对应子类，字段与 `FileData` 相同。
+
+## 支持的消息类型
+
+| 类型 | 说明 |
+|------|------|
+| `text` | 纯文本 |
+| `mention` | @某人 |
+| `mention_all` | @所有人 |
+| `image` | 图片 |
+| `voice` | 语音 |
+| `audio` | 音频 |
+| `video` | 视频 |
+| `file` | 文件 |
+| `location` | 位置 |
+| `reply` | 回复 |

python_library_onebot_protocol-0.1.0/onebot_protocol/__init__.py

@@ -0,0 +1,33 @@
+from .models import (
+    AudioMessageSegment,
+    FileData,
+    FileMessageSegment,
+    ImageMessageSegment,
+    LocationMessageSegment,
+    MentionAllMessageSegment,
+    MentionMessageSegment,
+    MessagePayload,
+    MessageSegment,
+    ReplyMessageSegment,
+    TextMessageSegment,
+    TextSegmentData,
+    VideoMessageSegment,
+    VoiceMessageSegment,
+)
+
+__all__ = [
+    "AudioMessageSegment",
+    "FileData",
+    "FileMessageSegment",
+    "ImageMessageSegment",
+    "LocationMessageSegment",
+    "MentionAllMessageSegment",
+    "MentionMessageSegment",
+    "MessagePayload",
+    "MessageSegment",
+    "ReplyMessageSegment",
+    "TextMessageSegment",
+    "TextSegmentData",
+    "VideoMessageSegment",
+    "VoiceMessageSegment",
+]

python_library_onebot_protocol-0.1.0/onebot_protocol/models.py

@@ -0,0 +1,139 @@
+from typing import Annotated, Any, Literal, Union
+from uuid import uuid4
+
+from pydantic import BaseModel, Field
+
+
+class TextSegmentData(BaseModel):
+    text: str = Field(description="纯文本")
+
+
+class MentionSegmentData(BaseModel):
+    user_id: str = Field(description="被 @ 的用户 ID")
+
+
+class MentionAllSegmentData(BaseModel):
+    pass
+
+
+class FileData(BaseModel):
+    name: str | None = Field(default=None, description="显示用文件名")
+    content: str | None = Field(
+        default=None,
+        description="内容引用，如 URL、平台资源标识或 Base64 等，由实现方约定编码",
+    )
+    mime_type: str | None = Field(default=None, description="MIME 类型")
+    size: int | None = Field(default=None, description="字节大小")
+
+
+class ImageSegmentData(FileData):
+    pass
+
+
+class VoiceSegmentData(FileData):
+    pass
+
+
+class AudioSegmentData(FileData):
+    pass
+
+
+class VideoSegmentData(FileData):
+    pass
+
+
+class FileSegmentData(FileData):
+    pass
+
+
+class LocationSegmentData(BaseModel):
+    latitude: float = Field(description="纬度")
+    longitude: float = Field(description="经度")
+    title: str = Field(description="位置标题")
+    content: str = Field(description="位置说明")
+
+
+class ReplySegmentData(BaseModel):
+    message_id: str = Field(description="被回复的消息 ID")
+    user_id: str | None = Field(default=None, description="被回复用户 ID")
+
+
+class TextMessageSegment(BaseModel):
+    type: Literal["text"] = "text"
+    data: TextSegmentData
+
+
+class MentionMessageSegment(BaseModel):
+    type: Literal["mention"] = "mention"
+    data: MentionSegmentData
+
+
+class MentionAllMessageSegment(BaseModel):
+    type: Literal["mention_all"] = "mention_all"
+    data: MentionAllSegmentData = Field(default_factory=MentionAllSegmentData)
+
+
+class ImageMessageSegment(BaseModel):
+    type: Literal["image"] = "image"
+    data: ImageSegmentData
+
+
+class VoiceMessageSegment(BaseModel):
+    type: Literal["voice"] = "voice"
+    data: VoiceSegmentData
+
+
+class AudioMessageSegment(BaseModel):
+    type: Literal["audio"] = "audio"
+    data: AudioSegmentData
+
+
+class VideoMessageSegment(BaseModel):
+    type: Literal["video"] = "video"
+    data: VideoSegmentData
+
+
+class FileMessageSegment(BaseModel):
+    type: Literal["file"] = "file"
+    data: FileSegmentData
+
+
+class LocationMessageSegment(BaseModel):
+    type: Literal["location"] = "location"
+    data: LocationSegmentData
+
+
+class ReplyMessageSegment(BaseModel):
+    type: Literal["reply"] = "reply"
+    data: ReplySegmentData
+
+
+MessageSegment = Annotated[
+    Union[
+        TextMessageSegment,
+        MentionMessageSegment,
+        MentionAllMessageSegment,
+        ImageMessageSegment,
+        VoiceMessageSegment,
+        AudioMessageSegment,
+        VideoMessageSegment,
+        FileMessageSegment,
+        LocationMessageSegment,
+        ReplyMessageSegment,
+    ],
+    Field(discriminator="type"),
+]
+
+
+class MessagePayload(BaseModel):
+    message_id: str = Field(default="", description="消息唯一 ID")
+    source_type: Literal["group", "private"] = Field(description="会话类型")
+    session_id: str = Field(description="会话 ID")
+    bot_id: str = Field(default="", description="机器人 ID")
+    user_id: str | None = Field(default=None, description="发送方用户 ID")
+    messages: list[MessageSegment] = Field(description="消息段列表")
+    post_type: str = Field(default="", description="事件类型")
+
+    def model_post_init(self, __context: Any) -> None:
+        if not self.message_id:
+            self.message_id = str(uuid4())

python_library_onebot_protocol-0.1.0/pyproject.toml

@@ -0,0 +1,16 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "python-library-onebot-protocol"
+version = "0.1.0"
+description = "OneBot 风格消息载荷与消息段模型"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "pydantic>=2.0,<3",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["onebot_protocol"]