pure-protobuf 1.2.0

纯协议

协议缓冲区的python实现。

数据类

pure protobuf允许您利用标准的dataclasses模块来定义消息类型。对于新项目，它比传统接口更受欢迎。dataclasses接口在python 3.6及更高版本中可用。

旧式接口已弃用，但仍可以通过pure\u protobuf.legacy

本指南介绍如何使用纯protobuf来构造数据。它试图遵循标准开发人员指南。它还假设您熟悉协议缓冲区。

定义消息类型

让我们看看这个简单的例子。下面是它在proto3语法中的样子：

syntax="proto3";messageSearchRequest{stringquery=1;int32page_number=2;int32result_per_page=3;}

这就是用纯protobuf定义它的方式：

# Python 3.6+fromdataclassesimportdataclassfrompure_protobuf.dataclasses_importfield,messagefrompure_protobuf.typesimportint32@message@dataclassclassSearchRequest:query:str=field(1,default='')page_number:int32=field(2,default=int32(0))result_per_page:int32=field(3,default=int32(0))assertSearchRequest(query='hello',page_number=int32(1),result_per_page=int32(10),).dumps()==b'\x0A\x05hello\x10\x01\x18\x0A'

请记住，@messagedecorator应该始终保持在@dataclasses之上。

序列化

每个用@消息包装的类都会附加两个方法：

• dumps（）->；字节将消息序列化为字节字符串
• 转储（io:io）将消息序列化为类似文件的对象

反序列化

每个用@message包装的类都会附加两个类方法：

• 加载（字节）->；t消息从字节字符串反序列化消息
• 加载（io:io）->；t消息从类似文件的对象反序列化消息

这些方法也可以作为pu中的独立函数使用关于protobuf.dataclasses

• 加载（cls:type[t]，io:io）->；t
• 加载（cls:type[t]，bytes懔bytes）->；t

指定字段类型

在pure protobuf中，类型由类型提示指定。支持原生pythonfloat、str、bytes和bool类型。由于其他协议缓冲区类型不作为本机python类型存在，因此包使用newtype来定义它们。它们可以通过pure_protobuf.types获得，并以相同的方式命名。

分配字段号

字段号是通过字段的元数据参数提供的：字段（…，metadata={'number'：number}）。但是，为了提高可读性并保存一些字符，pure protobuf提供了一个助手函数pure protobuf.dataclasses\field它接受字段号作为第一个位置参数并将其传递给标准的字段函数。

指定字段规则

键入.list和键入.iterable批注自动转换为重复字段。标量数字类型的重复字段默认使用压缩编码：

# Python 3.6+fromdataclassesimportdataclassfromtypingimportListfrompure_protobuf.dataclasses_importfield,messagefrompure_protobuf.typesimportint32@message@dataclassclassMessage:foo:List[int32]=field(1,default_factory=list)

也可以用typing.optional包装字段类型。如果none被分配给一个可选字段，则在序列化过程中将跳过该字段。

默认值

在纯protobuf中，开发人员有责任处理默认值。如果编码的消息不包含特定元素，则相应的字段保持未分配状态。这意味着字段的标准默认和默认工厂参数正常工作：

# Python 3.6+fromdataclassesimportdataclassfromtypingimportOptionalfrompure_protobuf.dataclasses_importfield,messagefrompure_protobuf.typesimportint32@message@dataclassclassFoo:bar:int32=field(1,default=42)qux:Optional[int32]=field(2,default=None)assertFoo().dumps()==b'\x08\x2A'assertFoo.loads(b'')==Foo(bar=42)

事实上，模式qux:optional[int32]=field（2，default=none）非常常见，因此有一个方便的函数optional\u field来定义默认值为none的optional字段：

# Python 3.6+fromdataclassesimportdataclassfromtypingimportOptionalfrompure_protobuf.dataclasses_importoptional_field,messagefrompure_protobuf.typesimportint32@message@dataclassclassFoo:qux:Optional[int32]=optional_field(2)assertFoo().dumps()==b''assertFoo.loads(b'')==Foo(qux=None)

枚举

支持标准类的子类：

# Python 3.6+fromdataclassesimportdataclassfromenumimportIntEnumfrompure_protobuf.dataclasses_importfield,messageclassTestEnum(IntEnum):BAR=1@message@dataclassclassTest:foo:TestEnum=field(1)assertTest(foo=TestEnum.BAR).dumps()==b'\x08\x01'assertTest.loads(b'\x08\x01')==Test(foo=TestEnum.BAR)

使用其他消息类型

嵌入消息的定义方式与普通数据类相同：

# Python 3.6+fromdataclassesimportdataclassfrompure_protobuf.dataclasses_importfield,messagefrompure_protobuf.typesimportint32@message@dataclassclassTest1:a:int32=field(1,default=0)@message@dataclassclassTest3:c:Test1=field(3,default_factory=Test1)assertTest3(c=Test1(a=int32(150))).dumps()==b'\x1A\x03\x08\x96\x01'

众所周知的消息类型

pure_protobuf.google还提供了以下已知消息类型的内置定义：

# Python 3.6+fromdataclassesimportdataclassfromdatetimeimportdatetimefromtypingimportOptionalfrompure_protobuf.dataclasses_importfield,message@message@dataclassclassTest:timestamp:Optional[datetime]=field(1,default=None)

# Python 3.6+fromdataclassesimportdataclassfromtypingimportAny,Optionalfrompure_protobuf.dataclasses_importfield,messagefrompure_protobuf.types.googleimportTimestamp@message@dataclassclassMessage:value:Optional[Any]=field(1)# Here `Timestamp` is used just as an example, in principle any importable user type works.message=Message(value=Timestamp(seconds=42))assertMessage.loads(message.dumps())==message

syntax="proto3";messageSearchRequest{stringquery=1;int32page_number=2;int32result_per_page=3;}

syntax="proto3";messageSearchRequest{stringquery=1;int32page_number=2;int32result_per_page=3;}

syntax="proto3";messageSearchRequest{stringquery=1;int32page_number=2;int32result_per_page=3;}

syntax="proto3";messageSearchRequest{stringquery=1;int32page_number=2;int32result_per_page=3;}

syntax="proto3";messageSearchRequest{stringquery=1;int32page_number=2;int32result_per_page=3;}

syntax="proto3";messageSearchRequest{stringquery=1;int32page_number=2;int32result_per_page=3;}

syntax="proto3";messageSearchRequest{stringquery=1;int32page_number=2;int32result_per_page=3;}

syntax="proto3";messageSearchRequest{stringquery=1;int32page_number=2;int32result_per_page=3;}