Як використовувати буфери протоколів 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 :)