Как да използваме буферите за протоколи на Google в Python

Когато хората, които говорят различни езици, се събират и говорят, те се опитват да използват език, който всички в групата разбират.

За да постигне това, всеки трябва да преведе мислите си, които обикновено са на родния им език, на езика на групата. Това „кодиране и декодиране“ на езика обаче води до загуба на ефективност, скорост и точност.

Същата концепция присъства в компютърните системи и техните компоненти. Защо трябва да изпращаме данни в XML, JSON или друг формат, четим от човека, ако няма нужда да разбираме за какво говорят директно? Стига да можем да го преведем в разбираем за човека формат, ако е изрично необходимо.

Протоколните буфери са начин за кодиране на данни преди транспортиране, което ефективно свива блоковете данни и следователно увеличава скоростта при изпращането им. Той абстрахира данните в неутрален за език и платформа формат.

Съдържание

  • Защо се нуждаем от буфери на протоколи?
  • Какво представляват буферите на протоколи и как работят?
  • Буфери на протоколи в Python
  • Заключителни бележки

Защо буфери на протоколи?

Първоначалната цел на протоколните буфери беше да опрости работата с протоколи за заявки / отговори. Преди ProtoBuf, Google използваше различен формат, който изискваше допълнителна обработка на маршалинга за изпратените съобщения.

В допълнение към това, новите версии на предишния формат изискваха от разработчиците да се уверят, че новите версии се разбират, преди да заменят старите, което създава трудности при работа.

Това е мотивирало Google да разработи интерфейс, който решава точно тези проблеми.

ProtoBuf позволява въвеждането на промени в протокола, без да се нарушава съвместимостта. Също така сървърите могат да преминават около данните и да изпълняват операции за четене на данните, без да променят съдържанието им.

Тъй като форматът се описва донякъде, ProtoBuf се използва като основа за автоматично генериране на код за сериализатори и десериализатори.

Друг интересен случай на употреба е как Google го използва за краткотрайни разговори за отдалечени процедури (RPC) и за постоянно съхраняване на данни в Bigtable. Поради специфичния им случай на използване те интегрираха RPC интерфейси в ProtoBuf. Това позволява бързо и лесно генериране на кодове, които могат да се използват като отправни точки за реалното изпълнение. (Повече за ProtoBuf RPC.)

Други примери за това, къде ProtoBuf може да бъде полезен, са за IoT устройства, които са свързани чрез мобилни мрежи, в които количеството изпратени данни трябва да бъде малко или за приложения в страни, където високата честотна лента все още е рядка. Изпращането на полезни товари в оптимизирани, двоични формати може да доведе до забележими разлики в оперативните разходи и скорост.

Използването на gzipкомпресия във вашата HTTPS комуникация може допълнително да подобри тези показатели.

Какво представляват буферите на протокола и как работят?

Най-общо казано, протоколните буфери са дефиниран интерфейс за сериализиране на структурирани данни. Той определя нормализиран начин на комуникация, напълно независим от езиците и платформите.

Google рекламира своя ProtoBuf така:

Протоколните буфери са езиково неутрален, неутрален от платформата, разширяем механизъм за сериализиране на структурирани данни - помислете за XML, но по-малък, по-бърз и по-опростен. Вие определяте как искате вашите данни да бъдат структурирани веднъж ...

Интерфейсът ProtoBuf описва структурата на данните, които трябва да бъдат изпратени. Структурите на полезния товар се дефинират като „съобщения“ в това, което се нарича прото-файлове. Тези файлове винаги завършват с.protoудължаване.

Например основната структура на файл todolist.proto изглежда така. Ще разгледаме и пълен пример в следващия раздел.

syntax = "proto3"; // Not necessary for Python, should still be declared to avoid name collisions // in the Protocol Buffers namespace and non-Python languages package protoblog; message TodoList { // Elements of the todo list will be defined here ... }

След това тези файлове се използват за генериране на интеграционни класове или заглушки за избрания от вас език, като се използват генератори на код в компилатора на protoc. Текущата версия, Proto3, вече поддържа всички основни езици за програмиране. Общността поддържа много повече в внедряванията на трети страни с отворен код.

Генерираните класове са основните елементи на протоколните буфери. Те позволяват създаването на елементи чрез създаване на инстанции на нови съобщения, базирани на .protoфайловете, които след това се използват за сериализация. Ще разгледаме подробно как се прави това с Python в следващия раздел.

Независимо от езика за сериализация, съобщенията се сериализират в не-самоописан, двоичен формат, който е доста безполезен без първоначалната дефиниция на структурата.

След това бинарните данни могат да се съхраняват, изпращат по мрежата и да се използват по какъвто и да е друг начин, четими от човека данни като JSON или XML. След предаване или съхранение, байтовият поток може да бъде десериализиран и възстановен, използвайки всеки специфичен за езика, компилиран клас protobuf, който генерираме от .proto файла.

Използвайки Python като пример, процесът може да изглежда по следния начин:

Първо, ние създаваме нов списък с задачи и го попълваме с някои задачи. След това този списък със задачи се сериализира и изпраща по мрежата, записва се във файл или постоянно се съхранява в база данни.

Изпратеният байтов поток се десериализира, използвайки метода на синтактичния анализ на нашия специфичен за езика, компилиран клас.

Повечето актуални архитектури и инфраструктури, особено микроуслуги, се основават на комуникация REST, WebSockets или GraphQL. Въпреки това, когато скоростта и ефективността са от съществено значение, RPC на ниско ниво могат да направят огромна разлика.

Вместо протоколи с високи режийни разходи, можем да използваме бърз и компактен начин за преместване на данни между различните обекти в нашата услуга, без да губим много ресурси.

Но защо все още не се използва навсякъде?

Протоколните буфери са малко по-сложни от другите, разбираеми от човека формати. Това ги прави сравнително по-трудни за отстраняване на грешки и интегриране във вашите приложения.

Времето на итерация в инженерството също се увеличава, тъй като актуализациите в данните изискват актуализиране на прото файловете преди употреба.

Трябва да се обмислят внимателно, тъй като ProtoBuf може да бъде свръхпроектирано решение в много случаи.

Какви алтернативи имам?

Several projects take a similar approach to Google’s Protocol Buffers.

Google’s Flatbuffers and a third party implementation, called Cap’n Proto, are more focused on removing the parsing and unpacking step, which is necessary to access the actual data when using ProtoBufs. They have been designed explicitly for performance-critical applications, making them even faster and more memory efficient than ProtoBuf.

When focusing on the RPC capabilities of ProtoBuf (used with gRPC), there are projects from other large companies like Facebook (Apache Thrift) or Microsoft (Bond protocols) that can offer alternatives.

Python and Protocol Buffers

Python already provides some ways of data persistence using pickling. Pickling is useful in Python-only applications. It's not well suited for more complex scenarios where data sharing with other languages or changing schemas is involved.

Protocol Buffers, in contrast, are developed for exactly those scenarios.

The .proto files, we’ve quickly covered before, allow the user to generate code for many supported languages.

To compile the .protofile to the language class of our choice, we use protoc, the proto compiler.

If you don’t have the protoc compiler installed, there are excellent guides on how to do that:

  • MacOS / Linux
  • Windows

Once we’ve installed protoc on our system, we can use an extended example of our todo list structure from before and generate the Python integration class from it.

syntax = "proto3"; // Not necessary for Python but should still be declared to avoid name collisions // in the Protocol Buffers namespace and non-Python languages package protoblog; // Style guide prefers prefixing enum values instead of surrounding // with an enclosing message enum TaskState { TASK_OPEN = 0; TASK_IN_PROGRESS = 1; TASK_POST_PONED = 2; TASK_CLOSED = 3; TASK_DONE = 4; } message TodoList { int32 owner_id = 1; string owner_name = 2; message ListItems { TaskState state = 1; string task = 2; string due_date = 3; } repeated ListItems todos = 3; } 

Let’s take a more detailed look at the structure of the .proto file to understand it.

In the first line of the proto file, we define whether we’re using Proto2 or 3. In this case, we’re using Proto3.

The most uncommon elements of proto files are the numbers assigned to each entity of a message. Those dedicated numbers make each attribute unique and are used to identify the assigned fields in the binary encoded output.

One important concept to grasp is that only values 1-15 are encoded with one less byte (Hex), which is useful to understand so we can assign higher numbers to the less frequently used entities. The numbers define neitherthe order of encoding nor the position of the given attribute in the encoded message.

The package definition helps prevent name clashes. In Python, packages are defined by their directory. Therefore providing a package attribute doesn’t have any effect on the generated Python code.

Please note that this should still be declared to avoid protocol buffer related name collisions and for other languages like Java.

Enumerations are simple listings of possible values for a given variable.

In this case, we define an Enum for the possible states of each task on the todo list.

We’ll see how to use them in a bit when we look at the usage in Python.

As we can see in the example, we can also nest messages inside messages.

If we, for example, want to have a list of todos associated with a given todo list, we can use the repeated keyword, which is comparable to dynamically sized arrays.

To generate usable integration code, we use the proto compiler which compiles a given .proto file into language-specific integration classes. In our case we use the --python-out argument to generate Python-specific code.

protoc -I=. --python_out=. ./todolist.proto

In the terminal, we invoke the protocol compiler with three parameters:

  1. -I: defines the directory where we search for any dependencies (we use . which is the current directory)
  2. --python_out: defines the location we want to generate a Python integration class in (again we use . which is the current directory)
  3. The last unnamed parameter defines the .proto file that will be compiled (we use the todolist.proto file in the current directory)

This creates a new Python file called _pb2.py. In our case, it is todolist_pb2.py. When taking a closer look at this file, we won’t be able to understand much about its structure immediately.

This is because the generator doesn’t produce direct data access elements, but further abstracts away the complexity using metaclasses and descriptors for each attribute. They describe how a class behaves instead of each instance of that class.

The more exciting part is how to use this generated code to create, build, and serialize data. A straightforward integration done with our recently generated class is seen in the following:

import todolist_pb2 as TodoList my_list = TodoList.TodoList() my_list.owner_id = 1234 my_list.owner_name = "Tim" first_item = my_list.todos.add() first_item.state = TodoList.TaskState.Value("TASK_DONE") first_item.task = "Test ProtoBuf for Python" first_item.due_date = "31.10.2019" print(my_list)

It merely creates a new todo list and adds one item to it. We then print the todo list element itself and can see the non-binary, non-serialized version of the data we just defined in our script.

owner_id: 1234 owner_name: "Tim" todos { state: TASK_DONE task: "Test ProtoBuf for Python" due_date: "31.10.2019" }

Each Protocol Buffer class has methods for reading and writing messages using a Protocol Buffer-specific encoding, that encodes messages into binary format.

Those two methods are SerializeToString() and ParseFromString().

import todolist_pb2 as TodoList my_list = TodoList.TodoList() my_list.owner_id = 1234 # ... with open("./serializedFile", "wb") as fd: fd.write(my_list.SerializeToString()) my_list = TodoList.TodoList() with open("./serializedFile", "rb") as fd: my_list.ParseFromString(fd.read()) print(my_list)

In the code example above, we write the Serialized string of bytes into a file using the wb flags.

Since we have already written the file, we can read back the content and Parse it using ParseFromString. ParseFromString calls on a new instance of our Serialized class using the rb flags and parses it.

If we serialize this message and print it in the console, we get the byte representation which looks like this.

b'\x08\xd2\t\x12\x03Tim\x1a(\x08\x04\x12\x18Test ProtoBuf for Python\x1a\n31.10.2019'

Note the b in front of the quotes. This indicates that the following string is composed of byte octets in Python.

If we directly compare this to, e.g., XML, we can see the impact ProtoBuf serialization has on the size.

 1234 Tim   TASK_DONE Test ProtoBuf for Python 31.10.2019   

The JSON representation, non-uglified, would look like this.

{ "todoList": { "ownerId": "1234", "ownerName": "Tim", "todos": [ { "state": "TASK_DONE", "task": "Test ProtoBuf for Python", "dueDate": "31.10.2019" } ] } }

Judging the different formats only by the total number of bytes used, ignoring the memory needed for the overhead of formatting it, we can of course see the difference.

But in addition to the memory used for the data, we also have 12 extra bytes in ProtoBuf for formatting serialized data. Comparing that to XML, we have 171 extra bytes in XML for formatting serialized data.

Without Schema, we need 136 extra bytes in JSON forformattingserialized data.

If we’re talking about several thousands of messages sent over the network or stored on disk, ProtoBuf can make a difference.

However, there is a catch. The platform Auth0.com created an extensive comparison between ProtoBuf and JSON. It shows that, when compressed, the size difference between the two can be marginal (only around 9%).

If you’re interested in the exact numbers, please refer to the full article, which gives a detailed analysis of several factors like size and speed.

An interesting side note is that each data type has a default value. If attributes are not assigned or changed, they will maintain the default values. In our case, if we don’t change the TaskState of a ListItem, it has the state of “TASK_OPEN” by default. The significant advantage of this is that non-set values are not serialized, saving additional space.

If we, for example, change the state of our task from TASK_DONE to TASK_OPEN, it will not be serialized.

owner_id: 1234 owner_name: "Tim" todos { task: "Test ProtoBuf for Python" due_date: "31.10.2019" }

b'\x08\xd2\t\x12\x03Tim\x1a&\x12\x18Test ProtoBuf for Python\x1a\n31.10.2019'

Final Notes

As we have seen, Protocol Buffers are quite handy when it comes to speed and efficiency when working with data. Due to its powerful nature, it can take some time to get used to the ProtoBuf system, even though the syntax for defining new messages is straightforward.

As a last note, I want to point out that there were/are discussions going on about whether Protocol Buffers are “useful” for regular applications. They were developed explicitly for problems Google had in mind.

If you have any questions or feedback, feel free to reach out to me on any social media like twitter or email :)