「ProtocolBuffers2」ProtocolBuffers2 Python简易入门
參考鏈接:
Protocol Buffer Basics: Python
Python Generated Code
Protocol Buffers Python API Reference
主要內(nèi)容
- 域
- 域的修飾符
- 域中的數(shù)據(jù)類型
- message方法
- 定義一個.proto文件
- 使用pb編譯器
- 使用pb讀寫消息
域(field)
域名 + {} = 一個完整的域,例如:
message 域名 {... }message是標(biāo)志符
域的修飾符
定義域時不需要修飾符,調(diào)用域類型(field type)時才需要
- optional :可選類型。未設(shè)定則使用默認(rèn)值;數(shù)值型默認(rèn)為0,字符串默認(rèn)空字符串,布爾默認(rèn)true或false
- repeated:可重復(fù)類型。可重復(fù)任意次數(shù),每次產(chǎn)生的均會被存儲,可看做一個動態(tài)變化的列表
- required :要求類型。一般不使用。
域中的數(shù)據(jù)類型
- bool
- int32
- float
- double
- string
- 其他定義的域
message方法
- IsInitialized():檢查是否所有required域是否設(shè)定
- __str__():輸出人類可讀的message,多用于debug。調(diào)用方式:str(message) / print message
- CopyFrom(other_msg):重寫message
- Clear():清除所有信息至空狀態(tài)
定義.proto文件
proto文件addressbook.proto內(nèi)容定義如下:
syntax = "proto2"; //proto版本申明語句package tutorial; // package申明,防止不同項目中的同名沖突,不會對代碼產(chǎn)生影響message Person {optional string name = 1;optional int32 id = 2;optional string email = 3;enum PhoneType { // 定義了一個enum類型,存儲預(yù)設(shè)定的值MOBILE = 0;HOME = 1;WORK = 2;}message PhoneNumber {optional string number = 1;optional PhoneType type = 2 [default = HOME]; // 使用enum}repeated PhoneNumber phones = 4; }message AddressBook {repeated Person people = 1; }該文件定義了三個message數(shù)據(jù)結(jié)構(gòu),主message是AddressBook,其他message都是圍繞該message展開;AddressBook帶一個可重復(fù)的(repeated)Person結(jié)構(gòu)(Person)的實例(people)。每個message是一個獨立且隔離的域,因此在每個域中每個變量的編號是從1開始。
考慮到一個字節(jié)(byte,8bit)可以表示0-15十六個數(shù)和計算機存儲的空間局部性,推薦將經(jīng)常使用的變量編碼為較小的值以提高效率。
編譯proto文件
編譯前要先安裝編譯器:Download Protocol Buffers
編譯命令:
protoc -I=/proto/file/folder/path --python_out=/compiled/saving/path /proto/file/path編譯xxx.proto文件后生成proto_pb2.py文件,直接在python導(dǎo)入生成的py文件即可
python protocol buffer編譯器并不直接生成獲取數(shù)據(jù)的代碼,而是生成一個特殊的描述器來描述.proto中定義的所有數(shù)據(jù)結(jié)構(gòu):
class Person(message.Message):__metaclass__ = reflection.GeneratedProtocolMessageType # 重要代碼class PhoneNumber(message.Message):__metaclass__ = reflection.GeneratedProtocolMessageTypeDESCRIPTOR = _PERSON_PHONENUMBERDESCRIPTOR = _PERSONclass AddressBook(message.Message):__metaclass__ = reflection.GeneratedProtocolMessageTypeDESCRIPTOR = _ADDRESSBOOK可以將這些代碼看做一個創(chuàng)建類的模板,在加載時,通過GeneratedProtocolMessageType元類來調(diào)用特殊描述器來創(chuàng)建所有proto定義內(nèi)容的python方法。
寫message
import addressbook_pb2 # 導(dǎo)入編譯好的py文件person_1 = addressbook_pb2.Person() # 申請一個Person實例 person_1.id = 123 # 賦值 person_1.name = "Dady" person_1.email = "xxxx@family.com"phone_1 = person.phones.add() # 對于repeated類數(shù)據(jù),使用add()來新增實例 phone_2 = person.phones.add() phone_1.number = "123-456-789" phone.type = addressbook_pb2.Person.Home讀message
在接收到一個message后,直接調(diào)用即可
import addressbook_pb2 # 假定接收到了一個address_book message,且address_book包含多個人for person in address_book.people:person_id = person.idperson_name = person.nameprint(person_id, person_name)總結(jié)
以上是生活随笔為你收集整理的「ProtocolBuffers2」ProtocolBuffers2 Python简易入门的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 石家庄地铁1号线到陆军作战指挥学院在那个
- 下一篇: 「Python-StandardLib」