首页
/ `pure-protobuf` 技术文档

`pure-protobuf` 技术文档

2024-12-26 09:10:45作者:翟江哲Frasier

1. 安装指南

pure-protobuf 是一个用于处理 Protocol Buffers 的 Python 库,支持使用 dataclassespydantic 来定义消息结构。以下是安装 pure-protobuf 的步骤:

使用 pip 安装

你可以通过 pip 来安装 pure-protobuf

pip install pure-protobuf

安装依赖

pure-protobuf 依赖于 typing_extensionspydantic(如果你选择使用 pydantic 来定义消息结构)。这些依赖项会在安装 pure-protobuf 时自动安装。

2. 项目的使用说明

pure-protobuf 允许你使用 Python 的 dataclassespydantic 来定义 Protocol Buffers 消息。以下是两种使用方式的示例:

使用 dataclasses 定义消息

from dataclasses import dataclass
from io import BytesIO

from pure_protobuf.annotations import Field
from pure_protobuf.message import BaseMessage
from typing_extensions import Annotated


@dataclass
class SearchRequest(BaseMessage):
    query: Annotated[str, Field(1)] = ""
    page_number: Annotated[int, Field(2)] = 0
    result_per_page: Annotated[int, Field(3)] = 0


request = SearchRequest(query="hello", page_number=1, result_per_page=10)
buffer = bytes(request)
assert buffer == b"\x0A\x05hello\x10\x01\x18\x0A"
assert SearchRequest.read_from(BytesIO(buffer)) == request

使用 pydantic 定义消息

from io import BytesIO

from pure_protobuf.annotations import Field
from pure_protobuf.message import BaseMessage
from pydantic import BaseModel
from typing_extensions import Annotated


class SearchRequest(BaseMessage, BaseModel):
    query: Annotated[str, Field(1)] = ""
    page_number: Annotated[int, Field(2)] = 0
    result_per_page: Annotated[int, Field(3)] = 0


request = SearchRequest(query="hello", page_number=1, result_per_page=10)
buffer = bytes(request)
assert buffer == b"\x0A\x05hello\x10\x01\x18\x0A"
assert SearchRequest.read_from(BytesIO(buffer)) == request

3. 项目 API 使用文档

pure-protobuf 提供了以下主要 API:

BaseMessage

BaseMessage 是所有消息类的基类。你可以通过继承 BaseMessage 并使用 dataclassespydantic 来定义消息结构。

Field

Field 是一个注解类,用于指定字段的编号。你可以通过 Annotated 来使用 Field,例如:

query: Annotated[str, Field(1)] = ""

序列化与反序列化

你可以使用 bytes() 函数将消息序列化为字节流,并使用 read_from() 方法从字节流中反序列化消息:

buffer = bytes(request)  # 序列化
request = SearchRequest.read_from(BytesIO(buffer))  # 反序列化

4. 项目安装方式

pure-protobuf 可以通过 pip 安装,具体步骤如下:

pip install pure-protobuf

如果你需要使用 pydantic,请确保已安装 pydantic

pip install pydantic

安装完成后,你可以通过导入 pure_protobuf 模块来使用该库。

from pure_protobuf.message import BaseMessage
from pure_protobuf.annotations import Field
from typing_extensions import Annotated

通过以上步骤,你可以轻松地使用 pure-protobuf 来处理 Protocol Buffers 消息。

热门项目推荐
相关项目推荐

项目优选

收起
Python-100-DaysPython-100-Days
Python - 100天从新手到大师
Python
373
72
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
276
72
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
200
47
xzs-mysqlxzs-mysql
学之思开源考试系统是一款 java + vue 的前后端分离的考试系统。主要优点是开发、部署简单快捷、界面设计友好、代码结构清晰。支持web端和微信小程序,能覆盖到pc机和手机等设备。 支持多种部署方式:集成部署、前后端分离部署、docker部署
HTML
5
1
LangChatLangChat
LangChat: Java LLMs/AI Project, Supports Multi AI Providers( Gitee AI/ 智谱清言 / 阿里通义 / 百度千帆 / DeepSeek / 抖音豆包 / 零一万物 / 讯飞星火 / OpenAI / Gemini / Ollama / Azure / Claude 等大模型), Java生态下AI大模型产品解决方案,快速构建企业级AI知识库、AI机器人应用
Java
11
3
gin-vue-admingin-vue-admin
🚀Vite+Vue3+Gin的开发基础平台,支持TS和JS混用。它集成了JWT鉴权、权限管理、动态路由、显隐可控组件、分页封装、多点登录拦截、资源权限、上传下载、代码生成器【可AI辅助】、表单生成器和可配置的导入导出等开发必备功能。
Go
16
3
source-vuesource-vue
🔥 一直想做一款追求极致用户体验的快速开发平台,看了很多优秀的开源项目但是发现没有合适的。于是利用空闲休息时间对若依框架进行扩展写了一套快速开发系统。如此有了开源字节快速开发平台。该平台基于 Spring Boot + MyBatis + Vue & Element ,包含微信小程序 & Uniapp, Web 报表、可视化大屏、三方登录、支付、短信、邮件、OSS...
Java
24
2
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
898
0
madongmadong
基于Webman的权限管理系统
PHP
4
0
cool-admin-javacool-admin-java
🔥 cool-admin(java版)一个很酷的后台权限管理框架,Ai编码、流程编排、模块化、插件化、CRUD极速开发,永久开源免费,基于springboot3、typescript、vue3、vite、element-ui等构建
Java
18
2